diff --git a/README.md b/README.md index 901fa66..7f904d5 100644 --- a/README.md +++ b/README.md @@ -4,3 +4,40 @@ Rust script index This is a index for rust-script-base +## Index repo format + +For example have scripts: +* sample.crs +* commit-msg.crs + +``` +scripts.txt +/s + /a + /m + /sample.crs + /v0001-0.1.0 + /sample.crs.json +/c + /o + /m + /commit-msg.crs + /v0001-1.0.0 + /commit-msg.crs.json +``` + +scripts.txt format: +``` +sample.crs +commit-msg.crs +``` + +JSON format: +```json +{ + "name": "sample.crs", + "hash": "sha256-xxXXxxXX", + "repo": "https://git.hatter.ink/rust-scripts/rust-script-base", + "gitHash": "xxXXxxXX" +} +```