README.md in dude-cli-1.0.2 vs README.md in dude-cli-2.0.0
- old
+ new
@@ -1,10 +1,10 @@
# Dude [](https://badge.fury.io/rb/dude-cli)
A daily assistant in the hard work of a programmer
-This program helps to combine such services as [Gitlab](https://gitlab.com), [Toggl](https://toggl.com) and replace most routine activities with one simple CLI utility.
+This program helps to combine such services as [Jira](https://atlassian.net), [Toggl](https://toggl.com) and replace most routine activities with one simple CLI utility.
## Installation
Add this line to your application's Gemfile:
@@ -24,47 +24,63 @@
$ dude install
And configure all variables in this file
-`TOGGL_EMAIL` - Your email, registered in Toggl
+`PROJECT_MANAGEMENT_TOOL=jira` - Project management (Now only Jira supported)
+`ATLASSIAN_EMAIL` - Your Jira email
-`TOGGL_TOKEN=` - Your Toggl [token](https://toggl.com/app/profile)
+`ATLASSIAN_TOKEN` - How to create Atlassian token: https://support.siteimprove.com/hc/en-gb/articles/360004317332-How-to-create-an-API-token-from-your-Atlassian-account
-`TOGGL_WORKSPACE_ID` - Your Toggl Workspace ID (You can find it in Toggl [team](https://toggl.com/app/team) or [projects](https://toggl.com/app/projects/) url)
+`ATLASSIAN_URL` - URL of your project. Example: https://example.atlassian.net
-`GITLAB_ENDPOINT=https://gitlab.yoursite.com/api/v4/` - Change yoursite.com to your site
+`ATLASSIAN_PROJECT_KEY` - KEY of your project. If your issues have id BT-123 - BT is the key
-`GITLAB_TOKEN=imyiKqwsQBbn1zCMY2PJ` - Your Gitlab token (<https://gitlab.yoursite.com/profile/personal_access_tokens>)
+`ATLASSIAN_BOARD_ID`:
+Just open your atlassian main board and copy id from the url after rapidView=*ID* part.
-`HOURS_PER_DAY=8` - Working hours per day
+Example: https://dealmakerns.atlassian.net/secure/RapidBoard.jspa?rapidView=23&projectKey=DT - 23 is the id
-`HOURS_PER_WEEK=40` - Working hours per week
-## Usage
+#### Replace it with your project list names. Skip for empty lists
-| Command | Required parameters | Optional parameters | Description |
-|---------------|:-------------------:|:-------------------------------:|------------------------------------------------------------|
-| dude install | - | - | Create .duderc file in your home directory |
-| dude checkout | issue_id | project_title<sup>1</sup> | Checkout to branch with name "ID-issue-title" |
-| dude track | issue_id | project_title<sup>1</sup> | Start time entry in Toggl with issue project, title and id |
-| dude tasks | - | project_title<sup>1</sup> | Show issues in current project assigned to you |
-| dude estimate | duration | issue_id<sup>2</sup>, project_title<sup>1</sup> | Estimate time for issue |
-| dude stop | - | project_title<sup>1</sup> | Stop current time entry in Toggl, move issue to `To Do` |
-| dude stats | - | - | Display your daily and weekly stats from Toggl |
-| dude start | issue_id | project_title<sup>1</sup> | Do `checkout`, `track` and `move` actions |
-| dude move | label | issue_id<sup>2</sup>, project_title<sup>1</sup> | Move issue to another column |
-| dude version | - | - | Display gem version |
+```
+TODO_LIST_NAME=To Do
+IN_PROGRESS_LIST_NAME=In Progress
+CODE_REVIEW_LIST_NAME=Code Review
+TESTING_LIST_NAME=TESTABLE
+DONE_LIST_NAME=Done
+```
-You also can use `dude help` for short description of every command.
+`TOGGL_PROJECT_NAME` - Your Toggl project name
-<sup>1</sup>: You can not specify a `project_title` if the project folder name matches its name<br>
-<sup>2</sup>: You can not specify `issue_id` if the correct name for the git branch is specified
+`TOGGL_TOKEN` - Your Toggl API token can be found at the bottom of the page: https://track.toggl.com/profile
+`TOGGL_WORKSPACE_ID` - Can be copied from url here: https://toggl.com/app/projects/. Example: 123456
+#### Use the *id* and *title* and specify format for the task titles in Trello or keep it as it is
+`TOGGL_TASK_FORMAT=[id] title`
+
+## Usage
+
+| Command | Required parameters | Optional parameters | Description |
+|:-------------:|:-------------------|:-------------------|:--------------------------------------------------------------------------------------|
+| dude install | - | - | Create .duderc file in your home directory |
+| dude checkout | ISSUE_ID | - | Checkout to branch with name "ID-issue-title" |
+| dude track | ISSUE_ID | - | Start time entry in Toggl with issue project, title and id |
+| dude tasks | ISSUE_ID | - | Show all issues in current project (For current sprint) |
+| dude stop | - | - | Stop current time entry in Toggl |
+| dude start | - | - | Do `checkout`, `track` and `move` actions |
+| dude move | ISSUE_ID | --list=NAME | Move issue to another column (Will provide options if called without --list parameter) |
+| dude version | - | - | Display gem version |
+
+You also can use `dude help` for short description of every command.
+
## Contributing
-Bug reports and pull requests are welcome on GitHub at https://github.com/Random4405/dude.
+Bug reports and pull requests are welcome on GitHub at https://github.com/npupko/dude.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## [Changelog](https://github.com/npupko/dude/CHANGELOG.md)