From 98169f8296566f00761446940b64504fcc3de50c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Georg=20J=C3=A4hnig?= Date: Sat, 2 Mar 2019 22:51:41 +0100 Subject: [PATCH] Link to wiki. --- README.md | 55 +------------------------------------------------------ 1 file changed, 1 insertion(+), 54 deletions(-) diff --git a/README.md b/README.md index a570093..eb7054a 100644 --- a/README.md +++ b/README.md @@ -2,57 +2,4 @@ This is a template for creating and managing our own user shortcuts, and for advanced settings. -To get started: - -1. Fork this repository into your own Github account. -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 - -## Custom configuration - -You may adjust [config.yml](config.yml) to your needs. - -### Namespaces - - namespaces: - - o - - en - - .us - - github: john-doe - name: john - - github: . - name: my - -This is an array of the [namespaces](https://github.com/trovu/trovu.github.io/wiki/Namespaces) you want to use. Every entry may be - -- a string: Then it refers to an (official) site namespace, i.e. one in the [trovu-data](https://github.com/trovu/trovu-data) repository. Shortcuts in there are curated by the Trovu community. -- key/value pairs, then they refer to a custom namespace, e.g. your (or someone else's) user namespace in Github. Every entry must contain: - - `github:` A Github user name, or a dot - - (optional) `name:` Some custom name (default: value from `github:`) - -The dot will refer to the current github user (where this `config.yml` is located). - -### Default keyword - - defaultKeyword: g - -If no keyword is recognized in a query, this one will be used. Useful for setting up a much used shortcut. - -### Language and Country - - language: en - -For Wikipedia or dictionaries in your language. Now, using the `w` shortcut will get you to the Wikipedia in your language. - - country: de - -For shortcuts that use `{$country}` in their URL. - -## Adding shortcuts - -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, - - for instance create `g.1.yml` for a shortcut with the keyword g and 1 argument. -- inside the created file, place the template url, - - like in the [given example](https://github.com/trovu/trovu-data-user/blob/master/shortcuts/examplekeyword.1.yml). +Read more: https://github.com/trovu/trovu.github.io/wiki/Advanced-settings-&-personal-shortcuts