Skip to content

Commit

Permalink
doc: Update all the READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
qdot committed Dec 31, 2022
1 parent c157104 commit 6347ea0
Show file tree
Hide file tree
Showing 5 changed files with 114 additions and 27 deletions.
26 changes: 11 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

[![Patreon donate button](https://img.shields.io/badge/patreon-donate-yellow.svg)](https://www.patreon.com/qdot)
[![Github donate button](https://img.shields.io/badge/github-donate-ff69b4.svg)](https://www.github.com/sponsors/qdot)
[![Discourse Forums](https://img.shields.io/discourse/status?label=buttplug.io%20forums&server=https%3A%2F%2Fdiscuss.buttplug.io)](https://discuss.buttplug.io)
[![Discord](https://img.shields.io/discord/353303527587708932.svg?logo=discord)](https://discord.buttplug.io)
[![Twitter](https://img.shields.io/twitter/follow/buttplugio.svg?style=social&logo=twitter)](https://twitter.com/buttplugio)

Expand All @@ -15,16 +16,16 @@
API Documentation
</a>
<span> | </span>
<a href="https://buttplug-spec.docs.buttplug.io">
<a href="https://docs.buttplug.io/docs/spec">
Protocol Spec
</a>
<span> | </span>
<a href="https://buttplug-developer-guide.docs.buttplug.io">
<a href="https://docs.buttplug.io/docs">
Developer Guide
</a>
<span> | </span>
<a href="https://github.com/buttplugio/buttplug-rs/releases">
Releases
<a href="https://awesome.buttplug.io">
Apps and Games List
</a>
</h3>
</div>
Expand All @@ -33,16 +34,15 @@
<img src="https://raw.githubusercontent.com/buttplugio/buttplug-rs/dev/buttplug/docs/buttplug_rust_docs.png">
</p>

Main repo for the Buttplug project, including the protocol spec, device config, and a full Rust implementation of the Buttplug Intimate Hardware Control Protocol.
A Rust implementation of the Buttplug Intimate Hardware Control Protocol, including a client and server. This is the core implementation of Buttplug.

This repo is a monorepo with multiple projects, including:

- [Buttplug Protocol Specification](spec/) - Protocol spec and docs
- [buttplug-schema](buttplug/buttplug-schema) - JSON schema for the Buttplug protocol spec
- [buttplug-device-config](buttplug/buttplug-device-config) - Device configuration file for buttplug (where we store all of the device identifiers)
- [buttplug](buttplug/) - Rust implementation of the Buttplug protocol spec
- [buttplug_device](buttplug_derive/) - Procedural macros used by the buttplug rust library.

- [buttplug-schema](buttplug/buttplug-schema) - JSON schema for the Buttplug protocol spec
- [buttplug-device-config](buttplug/buttplug-device-config) - Device configuration file for buttplug
(where we store all of the device identifiers)
- [buttplug_derive](buttplug_derive/) - Procedural macros used by the buttplug rust library.

For information about compiling and using these libraries, please check the
README files in their directories.
Expand All @@ -51,8 +51,4 @@ For a list of applications using Buttplug, see the [awesome-buttplug repo](https

## Other Language Implementations

See the [awesome-buttplug repo](https://github.com/buttplugio/awesome-buttplug) for a full list of implementations.

- [Buttplug C#](https://github.com/buttplugio/buttplug-rs-ffi/tree/master/csharp)
- [Buttplug JS/Typescript/WASM](https://github.com/buttplugio/buttplug-rs-ffi/tree/master/js)
- [Buttplug Python](https://github.com/buttplugio/buttplug-py)
See the [awesome-buttplug repo](https://github.com/buttplugio/awesome-buttplug#development-and-libraries) for a full list of implementations.
5 changes: 3 additions & 2 deletions buttplug/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

[![Patreon donate button](https://img.shields.io/badge/patreon-donate-yellow.svg)](https://www.patreon.com/qdot)
[![Github donate button](https://img.shields.io/badge/github-donate-ff69b4.svg)](https://www.github.com/sponsors/qdot)
[![Discourse Forums](https://img.shields.io/discourse/status?label=buttplug.io%20forums&server=https%3A%2F%2Fdiscuss.buttplug.io)](https://discuss.buttplug.io)
[![Discord](https://img.shields.io/discord/353303527587708932.svg?logo=discord)](https://discord.buttplug.io)
[![Twitter](https://img.shields.io/twitter/follow/buttplugio.svg?style=social&logo=twitter)](https://twitter.com/buttplugio)

Expand All @@ -15,11 +16,11 @@
API Documentation
</a>
<span> | </span>
<a href="https://buttplug-spec.docs.buttplug.io">
<a href="https://docs.buttplug.io/docs/spec">
Protocol Spec
</a>
<span> | </span>
<a href="https://buttplug-developer-guide.docs.buttplug.io">
<a href="https://docs.buttplug.io/docs">
Developer Guide
</a>
<span> | </span>
Expand Down
13 changes: 3 additions & 10 deletions buttplug/buttplug-device-config/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# Buttplug Device Configuration File

[![Patreon donate button](https://img.shields.io/badge/patreon-donate-yellow.svg)](https://www.patreon.com/qdot)
[![Discourse Forum](https://img.shields.io/badge/discourse-forum-blue.svg)](https://metafetish.club)
[![Discord](https://img.shields.io/discord/353303527587708932.svg?logo=discord)](https://discord.gg/t9g9RuD)
[![Github donate button](https://img.shields.io/badge/github-donate-ff69b4.svg)](https://www.github.com/sponsors/qdot)
[![Discourse Forums](https://img.shields.io/discourse/status?label=buttplug.io%20forums&server=https%3A%2F%2Fdiscuss.buttplug.io)](https://discuss.buttplug.io)
[![Discord](https://img.shields.io/discord/353303527587708932.svg?logo=discord)](https://discord.buttplug.io)
[![Twitter](https://img.shields.io/twitter/follow/buttplugio.svg?style=social&logo=twitter)](https://twitter.com/buttplugio)

[This file](buttplug-device-config.yml) contains information to bind
Expand All @@ -15,14 +16,6 @@ This file is mostly useful for implementation of Buttplug
reference libraries, and is not part of the official Buttplug
Protocol.

## Support The Project

If you find this project helpful, you
can
[support Metafetish projects via Patreon](http://patreon.com/qdot)!
Every donation helps us afford more hardware to reverse, document, and
write code for!

## License

buttplug is BSD 3-Clause licensed.
Expand Down
49 changes: 49 additions & 0 deletions buttplug/buttplug-schema/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Buttplug Spec JSON Message Schema

[![Patreon donate button](https://img.shields.io/badge/patreon-donate-yellow.svg)](https://www.patreon.com/qdot)
[![Github donate button](https://img.shields.io/badge/github-donate-ff69b4.svg)](https://www.github.com/sponsors/qdot)
[![Discourse Forums](https://img.shields.io/discourse/status?label=buttplug.io%20forums&server=https%3A%2F%2Fdiscuss.buttplug.io)](https://discuss.buttplug.io)
[![Discord](https://img.shields.io/discord/353303527587708932.svg?logo=discord)](https://discord.buttplug.io)
[![Twitter](https://img.shields.io/twitter/follow/buttplugio.svg?style=social&logo=twitter)](https://twitter.com/buttplugio)

The JSON schema for buttplug messages. Mainly used for the Rust Buttplug Server to verify messages
going in/out of the system.

While you *can* integrate schema checking in client implementations (and can at least be handy for
testing), it's not really needed. You can trust that the server will reject your message if it's
invalid.

## License

buttplug is BSD 3-Clause licensed.

```text
Copyright (c) 2016-2022, Nonpolynomial, LLC
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of buttplug nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
```
48 changes: 48 additions & 0 deletions buttplug_derive/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Buttplug Procedural Macro Library

[![Patreon donate button](https://img.shields.io/badge/patreon-donate-yellow.svg)](https://www.patreon.com/qdot)
[![Github donate button](https://img.shields.io/badge/github-donate-ff69b4.svg)](https://www.github.com/sponsors/qdot)
[![Discourse Forums](https://img.shields.io/discourse/status?label=buttplug.io%20forums&server=https%3A%2F%2Fdiscuss.buttplug.io)](https://discuss.buttplug.io)
[![Discord](https://img.shields.io/discord/353303527587708932.svg?logo=discord)](https://discord.buttplug.io)
[![Twitter](https://img.shields.io/twitter/follow/buttplugio.svg?style=social&logo=twitter)](https://twitter.com/buttplugio)

[![Crates.io Version](https://img.shields.io/crates/v/buttplug-derive)](https://crates.io/crates/buttplug-derive)
[![Crates.io Downloads](https://img.shields.io/crates/d/buttplug-derive)](https://crates.io/crates/buttplug-derive)
[![Crates.io License](https://img.shields.io/crates/l/buttplug-derive)](https://crates.io/crates/buttplug-derive)

Procedural macros for use in the implementation of the Rust version of Buttplug. Not much interesting to see here, it's mostly just derive macros for library traits.

## License

buttplug-derive is BSD 3-Clause licensed.

```text
Copyright (c) 2016-2022, Nonpolynomial, LLC
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of buttplug nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
```

0 comments on commit 6347ea0

Please sign in to comment.