Skip to content

Commit

Permalink
Update README (#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
jwilger authored Jan 9, 2025
1 parent ca4c18f commit dcb89a1
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

ADRs are automatically published to our Log4brains architecture knowledge base:

🔗 **<http://INSERT-YOUR-LOG4BRAINS-URL>**
🔗 **<http://commanded.github.io/adr>**

Please use this link to browse them.

Expand All @@ -11,21 +11,22 @@ Please use this link to browse them.
If not already done, install Log4brains:

```bash
npm install -g log4brains
npm install
```

To preview the knowledge base locally, run:

```bash
log4brains preview
npx log4brains preview
```

In preview mode, the Hot Reload feature is enabled: any change you make to a markdown file is applied live in the UI.
In preview mode, the Hot Reload feature is enabled: any change you make to a
markdown file is applied live in the UI.

To create a new ADR interactively, run:

```bash
log4brains adr new
npx log4brains adr new
```

## More information
Expand Down

0 comments on commit dcb89a1

Please sign in to comment.