Skip to content

Commit

Permalink
update readme and sample config
Browse files Browse the repository at this point in the history
  • Loading branch information
JonasHiltl committed Oct 8, 2024
1 parent b04caf3 commit ae2f773
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 4 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<p align="center">
<img width="750" src="https://github.com/user-attachments/assets/64259c72-17b7-479e-8079-98d7e2b72593"/>
<a href="https://demo.openchangelog.com" target="_blank">
<img width="750" src="https://github.com/user-attachments/assets/64259c72-17b7-479e-8079-98d7e2b72593"/>
</a>
<h1 align="center"><b>Openchangelog</b></h1>
</p>
<p align="center">
Expand All @@ -12,6 +14,8 @@
·
<a href="https://cloud.openchangelog.com">Get Started</a>
·
<a href="https://demo.openchangelog.com">Demo</a>
·
<a href="https://twitter.com/jonasdevs">Twitter</a>
</p>
<br />
Expand All @@ -20,13 +24,14 @@

Openchangelog takes your Markdown files, hosted on GitHub or locally and renders them as a beautiful Changelog Website.
- Dark, Light and System themes
- Colorful Tags
- Automatic RSS feed
- Easy to self-host, just a single config file
- Written in Go → lightweight
- Various integrations, open an issue to request a new integration

## Quickstart
Create an `openchangelog.yml` config file, for more infos see the [configuration](#configuration) section.
Create an `openchangelog.yml` config file, from the sample `openchangelog.example.yml`. For more configuration settings visit our [Docs](https://openchangelog.com/docs/getting-started/self-hosting/#configuration).
```
docker run -v ./openchangelog.yml:/etc/openchangelog.yml:ro -v ./release-notes:/release-notes -p 6001:6001 ghcr.io/jonashiltl/openchangelog:0.1.9
```
Expand Down
4 changes: 2 additions & 2 deletions openchangelog.example.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
addr: 0.0.0.0:6001
addr: localhost:6001
#github:
# owner:
# repo:
# path:
# auth:
# accessToken:
local:
filesPath: .testdata
filesPath: /release-notes
cache:
type: disk
disk:
Expand Down

0 comments on commit ae2f773

Please sign in to comment.