silentsilas
/
reiki
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update readme, add mit license

This commit is contained in:
Silas 2024-05-30 21:39:33 -04:00
parent 384299fa5e
commit 08597218a6
Failed to generate hash of commit
2 changed files with 28 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
LICENSE.md Normal file
View File

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2024 silentsilas
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.

8
README.md
View File

@ -2,4 +2,10 @@
Simple CLI tool to parse a directory of markdown files, retrieve a list of keywords via a rake model, and append them to their metadata.
If the YAML header is missing, or if the header is incorrect, this will break. Adjust the MetaData type in `cli.rs` to match the YAML header.
If the YAML header is missing, or if the header is incorrect, this will break. Adjust the MetaData type in `cli.rs` to match the YAML header.
## Usage
```
$ cargo run -- --filepath <path-to-directory>
```