Skip to content

Commit 77a6053

Browse files
committed
doc: Update README and add CHANGELOG
Add a changelog to show version features, update readme to fix architecture changes and add hardware supported.
1 parent 3c12420 commit 77a6053

File tree

3 files changed

+43
-24
lines changed

3 files changed

+43
-24
lines changed

CHANGELOG.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# 0.1.0 (2017-08-07)
2+
3+
- First release
4+
- Added support for the following hardware
5+
- XInput (XBox) Gamepads
6+
- Lovense Toys (vibration only)
7+
- Fleshlight Launch
8+
- Vorze A10 Cyclone
9+
- Magic Motion toys
10+
- Vibratissimo toys
11+
- Added libraries (available as nuget packages)
12+
- Core
13+
- Client
14+
- Server
15+
- XInputGamepadManager
16+
- UWPBluetoothManager
17+
- Added applications
18+
- Websocket Server
19+
- Kiiroo Platform Emulator
20+
21+
# 0.0.0 (2017-04-24)
22+
23+
- Project Started

README.md

Lines changed: 19 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -15,40 +15,35 @@ hardware that can communicate with computers.
1515

1616
The core of buttplug works as a router. It is an application that
1717
connects to driver libraries, to register and communicate with
18-
different hardware. Clients can then connect over websockets or
19-
network ports, to claim and interact with the hardware.
20-
21-
## C# Version
22-
23-
Buttplug is currently coming together in 3 languages simultaniously.
24-
This may sound stupid/nuts, and that's because it is. However,
25-
buttplug itself is fairly simple, so the goal here is to make the
26-
hardware support as transparent as possible for the user/developer.
27-
28-
The current implementation projects are in:
29-
30-
- [C#](http://github.com/metafetish/buttplug-csharp), for Windows, Unity, etc...
31-
- [Rust](http://github.com/metafetish/buttplug-rs), for all platforms,
32-
but currently requiring a LOT of yak shaving to get where we need to
33-
be with library
34-
support.
35-
[See this blog post for more info.](https://buttplug.io/blog/2017/03/26/the-yak-factory/)
36-
- Javascript (no central repo yet), for platforms with WebBluetooth
37-
support, and developers that want node or cordova support.
38-
39-
Whether any of these will get done is a really good question.
18+
different hardware. Clients can then connect over different means
19+
(network, websockets, etc...), to interact with the hardware.
20+
21+
## Other Buttplug Implementations
22+
23+
Buttplug implementations are available in multiple languages (rust,
24+
javascript, etc)/frameworks/platforms. For a full
25+
list,
26+
[see the README in the main buttplug repo](http://github.com/metafetish/buttplug).
4027

4128
## Platform Support
4229

4330
Buttplug C# Supports the following platforms:
4431

4532
- Windows 10 - Creators Update (15063)
46-
- BLE Devices: Fleshlight Launch, Lovense Toys, Vorze Interactive
33+
- BLE Devices: Fleshlight Launch, Lovense Toys, Vorze Interactive,
34+
Vibratissimo, Magic Motion
4735
- Other devices: Xbox Gamepads (XInput)
4836

4937
- Windows 7/8 and 10 pre 15063
5038
- Other devices: Xbox Gamepads (XInput)
5139

40+
## Development
41+
42+
Packages and libraries from the buttplug-csharp repo are available
43+
via [nuget](http://nuget.org). Simply run a search for "buttplug",
44+
or
45+
[follow this link to the nuget "buttplug" search](https://www.nuget.org/packages?q=buttplug).
46+
5247
## Special Installation Steps
5348

5449
Due to a bug in the Windows 15063 SDK, applications using the BLE APIs
@@ -75,7 +70,7 @@ write code for!
7570

7671
Buttplug is BSD licensed.
7772

78-
Copyright (c) 2016, Metafetish
73+
Copyright (c) 2016-2017, Metafetish
7974
All rights reserved.
8075

8176
Redistribution and use in source and binary forms, with or without

appveyor.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ image: Visual Studio 2017
1111
skip_commits:
1212
files:
1313
- README.md
14+
- CHANGELOG.md
1415

1516
skip_branch_with_pr: true
1617

0 commit comments

Comments
 (0)