You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Every time a new tag for the latest release is pushed to Github, the continuous integration builds in Travis-CI and AppVeyor will generate the binaries for each platform and architecture. We use [prebuild](https://github.com/mafintosh/prebuild) to publish these binaries on Github.
4
-
This can be checked in the .travis.yml file and appveyor.yml file. Within these files, if a git tag is detected a binary will be built and published for each version on each platform.
5
-
6
3
Two factor auth is required for publishing.
7
4
8
5
1. run `npm run publish`
9
-
2. if you released a new `@serialport/bindings` run `git tag @serialport/bindings@x.x.x` with the version you just released.
10
-
3. Let everyone know 🎉
11
-
12
-
Note:
13
-
14
-
CI sets the `prebuild_upload` environment variable with a GitHub token to trigger `prebuild` to upload the binaries to the release tag.
Copy file name to clipboardExpand all lines: README.md
+24-12Lines changed: 24 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -1,29 +1,37 @@
1
1
# Node Serialport
2
-
[](#backers)[](#sponsors)[](https://lernajs.io/)
2
+
3
+
[](#backers)
4
+
[](#sponsors)
-[The `serialport` package api docs](https://serialport.io/docs/api-serialport)
17
+
-[The `serialport` package api docs](https://serialport.io/docs/api-serialport) (most people start here)
16
18
17
19
### Serialport
20
+
18
21
-[`serialport`](https://serialport.io/docs/api-serialport) Chances are you're looking for the `serialport` package which provides a good set of defaults for most projects. However it is quite easy to mix and match the parts of serialport you need.
19
22
20
23
### Bindings
24
+
25
+
The code for bindings can be found here https://github.com/serialport/bindings-cpp
26
+
21
27
The Bindings provide a low level interface to work with your serialport. It is possible to use them alone but it's usually easier to use them with an interface.
28
+
22
29
-[`@serialport/bindings`](https://serialport.io/docs/api-bindings) bindings for Linux, Mac and Windows
23
30
-[`@serialport/binding-abstract`](https://serialport.io/docs/api-bindings-abstract) as an abstract class to use if you're making your own bindings
24
31
-[`@serialport/binding-mock`](https://serialport.io/docs/api-binding-mock) for a mock binding package for testing
25
32
26
33
### Interfaces
34
+
27
35
Interfaces take a binding object and provide a different API on top of it. Currently we only ship a Node Stream Interface.
28
36
29
37
-[`@serialport/stream`](https://serialport.io/docs/api-stream) our traditional Node.js Stream interface
@@ -45,6 +53,7 @@ Parsers are traditionally Transform streams, but Duplex streams and other non st
45
53
## Developing
46
54
47
55
### Developing node serialport projects
56
+
48
57
1. Clone this repo `git clone git@github.com:serialport/node-serialport.git`
49
58
1. Run `npm install` to setup local package dependencies (run this any time you depend on a package local to this repo)
50
59
1. Run `npm test` to ensure everything is working properly
@@ -53,15 +62,18 @@ Parsers are traditionally Transform streams, but Duplex streams and other non st
53
62
54
63
### Developing Docs
55
64
56
-
See https://github.com/node-serialport/website
65
+
See <https://github.com/serialport/website>
57
66
58
67
## License
68
+
59
69
SerialPort packages are all [MIT licensed](LICENSE) and all it's dependencies are MIT licensed.
60
70
61
71
## Code of Conduct
72
+
62
73
SerialPort follows the [Nodebots Code of Conduct](http://nodebots.io/conduct.html). While the code is MIT licensed participation in the community has some rules to make this a good place to work and learn.
63
74
64
75
### TLDR
76
+
65
77
- Be respectful.
66
78
- Abusive behavior is never tolerated.
67
79
- Data published to NodeBots is hosted at the discretion of the service administrators, and may be removed.
@@ -78,12 +90,11 @@ SerialPort is currently employees a [governance](https://medium.com/the-node-js-
78
90
79
91
If you have a PR that improves the project people in any or all of the above people will help you land it.
This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
@@ -99,13 +110,14 @@ Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com
99
110
100
111
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/serialport#sponsor)]
0 commit comments