diff --git a/README.md b/README.md index ecfdeb0..97ffbb2 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@

- + + +

Openchangelog

@@ -12,6 +14,8 @@ · Get Started · + Demo + · Twitter


@@ -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 ``` diff --git a/openchangelog.example.yml b/openchangelog.example.yml index ce18a99..2ba59c8 100644 --- a/openchangelog.example.yml +++ b/openchangelog.example.yml @@ -1,4 +1,4 @@ -addr: 0.0.0.0:6001 +addr: localhost:6001 #github: # owner: # repo: @@ -6,7 +6,7 @@ addr: 0.0.0.0:6001 # auth: # accessToken: local: - filesPath: .testdata + filesPath: /release-notes cache: type: disk disk: