diff options
| author | Matthew Hall <hallmatthew314@gmail.com> | 2023-03-07 01:34:41 +1300 |
|---|---|---|
| committer | Matthew Hall <hallmatthew314@gmail.com> | 2023-03-07 01:34:41 +1300 |
| commit | d5d09a5041a93e8b387e0dc2d5d8ace18a2adf25 (patch) | |
| tree | 6760e0257f15980da5e512d31a2e99e51946be07 /README.md | |
| parent | 14013d04f5023e68b5a804c3735e909241795878 (diff) | |
Update readme
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 37 |
1 files changed, 1 insertions, 36 deletions
@@ -1,39 +1,4 @@ # parcom -TODO: Write a description here +A simple parser combinator library for Crystal. -## Installation - -1. Add the dependency to your `shard.yml`: - - ```yaml - dependencies: - parcom: - github: your-github-user/parcom - ``` - -2. Run `shards install` - -## Usage - -```crystal -require "parcom" -``` - -TODO: Write usage instructions here - -## Development - -TODO: Write development instructions here - -## Contributing - -1. Fork it (<https://github.com/your-github-user/parcom/fork>) -2. Create your feature branch (`git checkout -b my-new-feature`) -3. Commit your changes (`git commit -am 'Add some feature'`) -4. Push to the branch (`git push origin my-new-feature`) -5. Create a new Pull Request - -## Contributors - -- [Matthew Hall](https://github.com/your-github-user) - creator and maintainer |
