Moved from repo.

This commit is contained in:
Georg Jähnig 2019-03-02 22:49:49 +01:00 committed by GitHub
parent ff10e25655
commit 7a023057eb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -5,7 +5,7 @@ This is a template for creating and managing our own user shortcuts, and for adv
To get started: To get started:
1. Fork this repository into your own Github account. 1. Fork this repository into your own Github account.
2. Adjust [config.yml](config.yml) to your needs, and add your own shortcuts (read more below). 2. Adjust [config.yml](https://github.com/trovu/trovu-data-user/blob/master/config.yml) to your needs, and add your own shortcuts (read more below).
3. Call Trovu with https://trovu.net/#github=YOUR_GITHUB_USERNAME 3. Call Trovu with https://trovu.net/#github=YOUR_GITHUB_USERNAME
## Custom configuration ## Custom configuration
@ -50,9 +50,9 @@ For shortcuts that use `{$country}` in their URL.
## Adding shortcuts ## Adding shortcuts
To add a new shortcut, follow the example in [shortcuts/examplekeyword.1.yml](shortcuts/examplekeyword.1.yml): To add a new shortcut, follow the example in [examplekeyword.1.yml](https://github.com/trovu/trovu-data-user/blob/master/shortcuts/examplekeyword.1.yml):
- create a file with the keyword and the argument number, - create a file with the keyword and the argument number,
- for instance create `g.1.yml` for a shortcut with the keyword g and 1 argument. - for instance create `g.1.yml` for a shortcut with the keyword g and 1 argument.
- inside the created file, place the template url, - inside the created file, place the template url,
- like in the [given example](shortcuts/examplekeyword.1.yml). - like in the [given example](https://github.com/trovu/trovu-data-user/blob/master/shortcuts/examplekeyword.1.yml).