Skip to content

Update README #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jwilger merged 2 commits into from
Jan 9, 2025
Merged

Update README #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a1a9c72
Update README
jwilger Jan 9, 2025
5f4dc55
Merge branch 'main' into update-readme
jwilger Jan 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions README.md
View file
Open in desktop
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