diff --git a/README.md b/README.md new file mode 100644 index 0000000..cace489 --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +Fork this repository to create our own, personal shortcuts. + +To use them, add the URL to your user repo to Trovu's URL. + +For instance, if + +- your Github repo is `john-doe` +- and you wish your Trovu user namespace to be `john` + +then call Trovu with: + + https://trovu.github.io/trovu-web/?# + #namespaces=o,de,.de,john + &namespace[john]=https://raw.githubusercontent.com/john-doe/trovu-user/master/{keyword}/{argumentCount}.txt +