diff options
| author | Matthew Hall <hallmatthew314@gmail.com> | 2023-03-07 01:30:02 +1300 |
|---|---|---|
| committer | Matthew Hall <hallmatthew314@gmail.com> | 2023-03-07 01:30:02 +1300 |
| commit | 14013d04f5023e68b5a804c3735e909241795878 (patch) | |
| tree | d4624f3dd19db4ba5600bfc72d91500ea58f73c0 /README.md | |
Initial
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..9d7d2d3 --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# parcom + +TODO: Write a description here + +## 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 |
