docs update

Author: barelyhuman

license

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022-Present Reaper <[email protected]> (https://reaper.im)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

readme.md

@@ -0,0 +1,29 @@
+# nimclog
+
+This is nim port of commitlog with a tighter scope
+
+## Why ?
+
+size, binary size.
+
+also, to get better at nimlang
+
+## Features
+
+- Sort git's logs into `features, fixes, others`
+- That's about it.
+
+## Installation
+
+I'm still testing the cross compiled binaries so you'll have to wait for it.
+Till then, you can compile it on your system using `nim` or `nimble`
+
+```sh
+nimble build
+# or
+nim c src/nimclog.nim
+```
+
+## License
+
+[MIT](/LICENSE)