Skip to content

Commit

Permalink
README: changed command name from "mite-go" to "mite"
Browse files Browse the repository at this point in the history
  • Loading branch information
phiros committed Apr 8, 2019
1 parent 6071666 commit c3f182e
Showing 1 changed file with 14 additions and 13 deletions.
27 changes: 14 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,24 @@
# Mite-go
# Mite

A [Mite](https://mite.yo.lk/en/) time tracking command line interface.
A [mite](https://mite.yo.lk/en/) time tracking command line interface.

## Setup

1. Grab a release from https://github.com/leanovate/mite-go/releases for your operating system and unpack it into your
1. Grab a release from https://github.com/leanovate/mite/releases for your operating system and unpack it into your
$PATH (or %PATH% on windows).
2. Setup `mite-go` to use your API key by:
2. Make sure that the `mite` command is executable by executing `mite version` in your shell
3. Setup `mite` to use your API key by:
1. visiting https://"your account name here".mite.yo.lk/myself and note down the API key
2. executing the following commands
`mite-go config api.key="your API key here"`
`mite-go config api.url=https://"your account name here".mite.yo.lk`
3. Optional: set a default project & service by:
1. retrieving the desired project & service id by executing `mite-go projects` and `mite-go services` respectively
2. configuring those id's as default by executing `mite-go config projectId="the project id"` and `mite-go config serviceId="the service id"`
4. Optional: mite-go allows you to define often used project & service combinations as activities. You can configure them by:
`mite config api.key="your API key here"`
`mite config api.url=https://"your account name here".mite.yo.lk`
4. Optional: set a default project & service by:
1. retrieving the desired project & service id by executing `mite projects` and `mite services` respectively
2. configuring those id's as default by executing `mite config projectId="the project id"` and `mite config serviceId="the service id"`
5. Optional: mite allows you to define often used project & service combinations as activities. You can configure them by:
1. think of a good name for the activity
2. run `mite-go config activity."your activity name here".projectId="the project id"`
3. run `mite-go config activity."your activity name here".serviceId=<the service id"`
2. run `mite config activity."your activity name here".projectId="the project id"`
3. run `mite config activity."your activity name here".serviceId=<the service id"`
4. the activity names can be used in the `entries create` and `entries edit` sub-commands

# Usage
Expand All @@ -33,4 +34,4 @@ Supported sub-commands:
| services | list & adds services |
| tracker | starts, stops and shows the status of the tracker |

For an up-to-date usage check `mite-go help`.
For an up-to-date usage check `mite help`.

0 comments on commit c3f182e

Please sign in to comment.