Skip to content

Commit

Permalink
prepare readme for the release
Browse files Browse the repository at this point in the history
  • Loading branch information
marouni committed Aug 26, 2018
1 parent af4709f commit 3e9b05d
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,27 @@ Greatly inspired by the [adr-tools](https://github.com/npryce/adr-tools) with al

# Quick start
## Installing adr
Go to the [releases page](https://github.com/marouni/adr/releases) and grab one of the binaries that corresponds to your platform.

Alternatively, if you have a Go developement environment setup you can install it directly using :
```bash
go install github.com/marouni/adr
```


## Initializing adr
Before creating any new ADR you need to choose a folder that will host your ADRs and use the `init` sub-command to initialize the configuration :

```bash
adr init /home/user/my_adrs
```

## Creating a new ADR

As simple as :
```bash
adr new my awesome proposition
```
this will create a new numbered ADR in your ADR folder :
`xxx-my-new-awesome-proposition.md`.
Next, just open the file in your preferred markdown editor and starting writing your ADR.

0 comments on commit 3e9b05d

Please sign in to comment.