From d5d09a5041a93e8b387e0dc2d5d8ace18a2adf25 Mon Sep 17 00:00:00 2001 From: Matthew Hall Date: Tue, 7 Mar 2023 01:34:41 +1300 Subject: Update readme --- README.md | 37 +------------------------------------ 1 file changed, 1 insertion(+), 36 deletions(-) diff --git a/README.md b/README.md index 9d7d2d3..e75c8d1 100644 --- a/README.md +++ b/README.md @@ -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 () -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 -- cgit v1.2.1