29 lines
656 B
Markdown
29 lines
656 B
Markdown
# Simple Serial Protocol (SSP)
|
|
|
|
SSP is a easy-to-use serial protocol system for arduino type devices.
|
|
|
|
## Installation
|
|
|
|
Use the package manager [pip](https://pip.pypa.io/en/stable/) to install foobar.
|
|
|
|
```bash
|
|
pip install foobar
|
|
```
|
|
|
|
## Usage
|
|
|
|
```python
|
|
import foobar
|
|
|
|
foobar.pluralize('word') # returns 'words'
|
|
foobar.pluralize('goose') # returns 'geese'
|
|
foobar.singularize('phenomena') # returns 'phenomenon'
|
|
```
|
|
|
|
## Contributing
|
|
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
|
|
|
|
Please make sure to update tests as appropriate.
|
|
|
|
## License
|
|
[MIT](https://choosealicense.com/licenses/mit/) |