aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGanesh Viswanathan <dev@genotrance.com>2020-05-04 15:48:34 -0500
committerGanesh Viswanathan <dev@genotrance.com>2020-05-04 15:48:34 -0500
commit6cfe59debce37dccf1a118f83f3b15050bcbab09 (patch)
tree283def41c725503fd35f54825daea9579f12aa79
parent35b0b5eff7ea789afd4bde56344ffdaa75ce31b3 (diff)
downloadnimterop-6cfe59debce37dccf1a118f83f3b15050bcbab09.tar.gz
nimterop-6cfe59debce37dccf1a118f83f3b15050bcbab09.zip
Update README with changelog, credits
-rw-r--r--README.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/README.md b/README.md
index 6fbc040..8680048 100644
--- a/README.md
+++ b/README.md
@@ -34,6 +34,8 @@ Nimterop can be used in two ways:
Any combination of the above is possible - only download, build or wrapping and nimterop avoids imposing any particular workflow.
+Refer to [CHANGES.md](CHANGES.md) for history and information around breaking changes.
+
### Build API
Creating a wrapper has two parts, the first is to setup the C library. This includes downloading it or finding it if already installed, and building it if applicable. The `getHeader()` high-level API provides all of this functionality as a convenience. The following `.nim` wrapper file is an example of using the high-level `getHeader()` API to perform all building, wrapping and linking automatically:
@@ -224,6 +226,8 @@ This is part of the reason why Nimterop provides a wrapper API so that the gener
Nimterop depends on [tree-sitter](http://tree-sitter.github.io/tree-sitter/) and all licensing terms of [tree-sitter](https://github.com/tree-sitter/tree-sitter/blob/master/LICENSE) apply to the usage of this package. The tree-sitter functionality is pulled and wrapped using nimterop itself.
+Thank you to all the [contributors](https://github.com/nimterop/nimterop/graphs/contributors), issue submitters, various people in [#nim](irc://freenode.net/nim) and users for helping improve Nimterop over the years.
+
## Feedback
Nimterop is a work in progress and any feedback or suggestions are welcome. It is hosted on [GitHub](https://github.com/nimterop/nimterop) with an MIT license so issues, forks and PRs are most appreciated.