Skip to content

Commit 3b6890a

Browse files
committed
refs #2: adds license and readme file
1 parent 20ec19d commit 3b6890a

File tree

2 files changed

+49
-0
lines changed

2 files changed

+49
-0
lines changed

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
Copyright (c) 2011 Codevise Solutions Limited
2+
3+
Permission is hereby granted, free of charge, to any person obtaining
4+
a copy of this software and associated documentation files (the
5+
Software), to deal in the Software without restriction, including
6+
without limitation the rights to use, copy, modify, merge, publish,
7+
distribute, sublicense, and/or sell copies of the Software, and to
8+
permit persons to whom the Software is furnished to do so, subject to
9+
the following conditions:
10+
11+
The above copyright notice and this permission notice shall be
12+
included in all copies or substantial portions of the Software.
13+
14+
THE SOFTWARE IS PROVIDED AS IS, WITHOUT WARRANTY OF ANY KIND,
15+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21+

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Redmine CLI
2+
A simple command line client for the redmine project managment tool (see http://redmine.org/ ).
3+
4+
## Installation
5+
Clone the repository and simply add the `bin` directory to your PATH.
6+
7+
Redmine CLI uses git config as configuration backend. You have to set some git config variables.
8+
9+
git config --global redmine.apikey 2d2972329e271a2a1c6d4322e3727001 # Your redmine API key
10+
git config --global redmine.url http://redmine.your-domain.org # URL of your redmine installation
11+
git config redmine.project my-project # ID of your project
12+
13+
## Usage
14+
$ redmine
15+
Tasks:
16+
redmine commit [COMMAND] # Commit with ticket ref.
17+
redmine help [TASK] # Describe available tasks or one specific task
18+
redmine list [COMMAND] # List issues.
19+
redmine show [COMMAND] # Show issue information.
20+
redmine time [COMMAND] # Worktime management.
21+
Use the built in documentation mechanism, i.e.
22+
$ redmine help list
23+
and
24+
$ redmine list help open
25+
26+
## License
27+
28+
See LICENSE.

0 commit comments

Comments
 (0)