Skip to content

Commit 3022b69

Browse files
authored
optimize README (#131)
- Improve description - Add installation guide - referencing to Tampermonkey as preferred user script manager (as on the send2cgeo website) - Fix typo
1 parent 8c54938 commit 3022b69

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,16 @@
11
# send2cgeo
22

3-
Script for Mozilla Firefox and Google Chrome browser to [send geocaches directly from your browser to c:geo](http://www.cgeo.org/send2cgeo.html) on your phone.
3+
**send2cgeo** is a Tampermonkey/Greasemonkey script for geocaching.com and opencaching.de, which allows you to send geocaches directly from your browser to [c:geo](https://www.cgeo.org/) on your phone.
4+
For more information, please visit the [send2cgeo website](https://www.cgeo.org/send2cgeo.html).
5+
## Installation
6+
- Install the [Tampermonkey Add-On](https://www.tampermonkey.net/) or a different user script manager in your browser
7+
- After that, click [here](https://github.com/cgeo/send2cgeo/raw/release/send2cgeo.user.js) to install send2cgeo inside your user script manager (e.g. Tampermonkey)
8+
- Finally, you have to [pair your browser with your phone](https://www.cgeo.org/send2cgeo.html#registering-browser-and-device) and you're ready!
9+
- If you need any further help, it's the best to visit the [send2cgeo installation guide](https://www.cgeo.org/send2cgeo#how-to-install-send2cgeo) on our website
10+
411

512
## Version management
613

7-
Changes must be done on the `master` branch. Once the changes are validated and ready to release, they can be merged to the `release` branch. The script version number needs to be derived from the actual date of release and set accordingly in the scripts `@version` tag before that merge (it needs be be larger than the existing version number on `release`) to trigger a rollout automatically.
14+
Changes must be done on the `master` branch. Once the changes are validated and ready to release, they can be merged to the `release` branch. The script version number needs to be derived from the actual date of release and set accordingly in the scripts `@version` tag before that merge (it needs to be larger than the existing version number on `release`) to trigger a rollout automatically.
815

9-
The script download link on the [c:geo homepage](http://cgeo.org) as well as the update mechanism for the installed script directly targets the raw script on the `release` branch, which means after merging the changes to `release`, together with the required version number increase, users will see the update on the website and script hosts (e.g. Greasemonkey) will detect and notify users to update.
16+
The script download link on the [c:geo homepage](https://www.cgeo.org) as well as the update mechanism for the installed script directly targets the raw script on the `release` branch, which means after merging the changes to `release`, together with the required version number increase, users will see the update on the website and script hosts (e.g. Tampermonkey) will detect and notify users to update.

0 commit comments

Comments
 (0)