iv-org/protodec
1
0
Fork 0
mirror of https://github.com/iv-org/protodec.git synced 2024-12-21 21:55:25 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Samantaz Fox 2021-11-29 22:52:01 +01:00 committed by GitHub
parent 7de78da0f8
commit 618a336060
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -2,6 +2,30 @@
Command-line tool to encode and decode arbitrary protobuf data. Command-line tool to encode and decode arbitrary protobuf data.
## Installation
This pragram requires Crystal. See: https://crystal-lang.org/install/
### Standalone
1. Clone: `git clone https://github.com/iv-org/protodec && cd protodec`
2. Build: `crystal build src/protodec.cr`
3. See [Usage](#Usage) below
### As a Crystal library
Add this to your application's `shard.yml`:
```yaml
dependencies:
protodec:
github: iv-org/protodec
version: ~> 0.1.4
```
## Usage ## Usage
``` ```
@ -63,7 +87,7 @@ Windows users can run the binaries in a linux-on-windows tool (like Git bash or
## Contributing ## Contributing
1. Fork it (<https://github.com/omarroth/protodec/fork>) 1. Fork it (<https://github.com/iv-org/protodec/fork>)
2. Create your feature branch (`git checkout -b my-new-feature`) 2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`) 3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`) 4. Push to the branch (`git push origin my-new-feature`)