Skip to content

Commit 0f32162

Browse files
committed
doc: Update LICENSE and README for 0.5.8
1 parent 498edb9 commit 0f32162

2 files changed

Lines changed: 13 additions & 46 deletions

File tree

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Buttplug is covered under the following BSD 3-Clause License
22

3-
Copyright (c) 2017-2019, Nonpolynomial Labs, LLC All rights reserved.
3+
Copyright (c) 2017-2020, Nonpolynomial Labs, LLC All rights reserved.
44

55
Redistribution and use in source and binary forms, with or without
66
modification, are permitted provided that the following conditions are

README.md

Lines changed: 12 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -42,24 +42,15 @@ Desktop](https://intiface.com/desktop).
4242
## Support The Project
4343

4444
If you find this project helpful, you can [support us via
45-
Patreon](http://patreon.com/qdot)! Every donation helps us afford more
46-
hardware to reverse, document, and write code for!
45+
Patreon](http://patreon.com/qdot) or [Github
46+
Sponsors](https://github.com/sponsors/qdot)! Every donation helps us
47+
afford more hardware to reverse, document, and write code for!
4748

4849
## Documentation
4950

5051
Documentation is available for the Buttplug Protocol and Frameworks,
5152
as well as this specific library.
5253

53-
### Developer Guide
54-
55-
The [Buttplug Developer
56-
Guide](https://buttplug-developer-guide.docs.buttplug.io) is the best
57-
introduction to how Buttplug works as a system. It provides an
58-
architectural overview of the various libraries and development
59-
strategies, as well as code examples in multiple languages.
60-
61-
[https://buttplug-developer-guide.docs.buttplug.io](https://buttplug-developer-guide.docs.buttplug.io)
62-
6354
### Library Usage Examples
6455

6556
Want to know what using the library looks like in code? The project
@@ -73,8 +64,6 @@ includes some heavily commented examples!
7364
- [Part 6 - Logging and Error Handling](https://github.com/buttplugio/buttplug-csharp/blob/master/Buttplug.Examples.06.LoggingAndErrorHandling/Program.cs)
7465
- [Part 7 - Full Example Program](https://github.com/buttplugio/buttplug-csharp/blob/master/Buttplug.Examples.07.FullProgram/Program.cs)
7566

76-
For examples of Xamarin (Android/iOS) applications, [see the buttplug-xamarin-examples repo](https://github.com/buttplugio/buttplug-xamarin-examples).
77-
7867
### Library API Documentation
7968

8069
API documentation for the current release is available at
@@ -92,27 +81,7 @@ website](https://buttplug.io).
9281

9382
## Hardware Support
9483

95-
Buttplug C# Supports the following Devices:
96-
- BLE Devices
97-
- Fleshlight Launch
98-
- Kiiroo Toys (Onyx, Pearl, Onyx 2, Pearl 2)
99-
- LiBo Toys
100-
- Lovense Toys
101-
- Magic Motion Toys
102-
- Mysteryvibe Crescendo and Tenuto
103-
- OhMiBod Fuse
104-
- Svakom Ella
105-
- Vibratissimo Toys
106-
- Vorze Interactive A10 Cyclone SA
107-
- Vorze UFO SA
108-
- WeVibe Toys
109-
- Youcups Warrior II
110-
- USB Devices
111-
- Rez Trancevibrator
112-
- Vorze Cyclone X10
113-
- RealTouch
114-
- Other Devices
115-
- Xbox Compatible Gamepads (XInput, Vibration Control Only)
84+
For a full list of supported devices, check out [IOSTIndex](https://iostindex.com/?filter0ButtplugSupport=1).
11685

11786
Operating System support is as follows:
11887

@@ -122,16 +91,6 @@ Operating System support is as follows:
12291
- Windows 7/8 and 10 pre 15063
12392
- All USB/Serial/Other Devices (No Bluetooth)
12493

125-
- Linux/Mac (Mono)
126-
- All USB/Serial Devices (No Bluetooth, No XInput)
127-
128-
- Android/iOS (Xamarin)
129-
- All Bluetooth LE devices (No USB, No XInput, No Serial)
130-
131-
Check [https://buttplug.io](https://buttplug.io) for a list a fully
132-
up-to-date list of supported hardware, as well as planned hardware
133-
support.
134-
13594
## Installation
13695

13796
Packages and libraries from the buttplug-csharp repo are available via
@@ -165,6 +124,14 @@ Manager project are hard-linked to the C:\ drive. If your program
165124
files and SDKs are not on your C: drive, you may need to readjust
166125
these paths by hand.
167126

127+
## Unity Support
128+
129+
Unity support is provided via a Unity Custom Package file, and is
130+
available in the
131+
[Releases](https://github.com/buttplug-csharp/releases) section.
132+
133+
For information on installing and using the Buttplug Unity Package, see the [ButtplugUnity README file](https://github.com/buttplugio/buttplug-csharp/tree/master/ButtplugUnity)
134+
168135
## Third Party Applications Using Buttplug C#
169136

170137
- [Intiface Desktop](https://intiface.com/desktop) - Intiface Desktop sex toy server software

0 commit comments

Comments
 (0)