updates to readme
Signed-off-by: Michael <michael.lindman@gmail.com>
This commit is contained in:
parent
acf517f50f
commit
cb3726bd07
36
README.md
36
README.md
|
@ -1,3 +1,37 @@
|
|||
# discourse-protobuf
|
||||
|
||||
Protocol buffers for the Discourse forum API
|
||||
[![Go Reference](https://pkg.go.dev/badge/git.0cd.xyz/michael/discourse-protobuf.svg)](https://pkg.go.dev/git.0cd.xyz/michael/discourse-protobuf)
|
||||
|
||||
Protocol buffers for the Discourse forum API.
|
||||
|
||||
## Building
|
||||
|
||||
To build the latest proto files run:
|
||||
|
||||
```sh
|
||||
make proto
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
```text
|
||||
MIT License Copyright (c) 2021 Michael Lindman
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is furnished
|
||||
to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice (including the next
|
||||
paragraph) shall be included in all copies or substantial portions of the
|
||||
Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
|
||||
OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
||||
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
|
||||
OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
```
|
||||
|
|
Loading…
Reference in New Issue