Skip to content

Commit c238b97

Browse files
authored
Merge pull request #20 from gtt-project/fix/documentation
Fix/documentation
2 parents 3b141cd + 60823df commit c238b97

File tree

2 files changed

+18
-2
lines changed

2 files changed

+18
-2
lines changed

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,23 @@ More information on installing (and uninstalling) Redmine plugins can be found h
3838

3939
## How to use
4040

41-
[Settings, screenshots, etc.]
41+
- Make sure REST web services is enabled: http://localhost:3000/settings?tab=api
42+
- Enable the plugin in project settings
43+
44+
The Geo-Task-Tracker (GTT) S.M.A.S.H plugin is connects the S.M.A.S.H mobile app with Redmine GTT.
45+
It adds new API endpoints to provide the tracker type configuration as custom notes.
46+
47+
**Project level API endpoint**
48+
49+
```
50+
http://localhost:3000/projects/(project_id)/smash/tags.json
51+
```
52+
53+
**Global level API endpoint**
54+
55+
```
56+
http://localhost:3000/smash/tags.json
57+
```
4258

4359
## Contributing and Support
4460

init.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
name 'Redmine GTT SMASH Plugin'
55
author 'Georepublic'
66
description 'Adds SMASH integration capabilities for GTT projects'
7-
version '0.0.1'
7+
version '1.0.0'
88
url 'https://github.com/gtt-project/redmine_gtt_smash'
99
author_url 'https://github.com/gtt-project'
1010

0 commit comments

Comments
 (0)