Skip to content

Commit 5dac6b3

Browse files
committed
reorganize readme with index
1 parent 22f111a commit 5dac6b3

File tree

1 file changed

+23
-15
lines changed

1 file changed

+23
-15
lines changed

README.md

Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,20 @@
22

33
It's a cli tool to manage work times.
44

5+
<!-- TOC -->
6+
* [worktimers](#worktimers)
7+
* [Usage](#usage)
8+
* [start working](#start-working)
9+
* [stop working](#stop-working)
10+
* [list worked intervals](#list-worked-intervals)
11+
* [Installation](#installation)
12+
* [install from source](#install-from-source)
13+
* [install release](#install-release)
14+
* [add config](#add-config)
15+
* [Development](#development)
16+
* [create a release](#create-a-release)
17+
<!-- TOC -->
18+
519
## Usage
620

721
### start working
@@ -40,24 +54,19 @@ The output will look like this:
4054

4155
## Installation
4256

43-
### install rust
44-
45-
https://www.rust-lang.org/tools/install
57+
### install from source
4658

47-
or
48-
49-
```shell
50-
brew install rustup-init
51-
```
5259

53-
### installation
54-
#### binary
60+
### install release
5561
1. download the latest release
5662
2. chmod +x worktimers
5763
3. move it to your PATH
5864

59-
#### from source
6065
```shell
66+
# install rust
67+
brew install rustup-init
68+
69+
# build and install worktimers
6170
make install
6271
```
6372

@@ -75,8 +84,7 @@ add `.worktimers.json` to your home directory and adjust the following content:
7584
## Development
7685

7786
### create a release
87+
1. make a commit
88+
2. push it
89+
3. github actions will create a release
7890

79-
1. bump the version in [Cargo.toml](Cargo.toml)
80-
1. create a commit with all changes
81-
1. tag the commit `git tag 0.2.0`
82-
1. `git push && git push --tags`

0 commit comments

Comments
 (0)