Add readme and license

1 files changed, 60 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8caaef0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,60 @@
+# Zola ʕ•ᴥ•ʔ Bear Blog
+
+🧸 A [Zola](https://www.getzola.org/)-theme based on [Bear Blog](https://bearblog.dev).
+
+> Free, no-nonsense, super-fast blogging.
+
+## Demo
+
+For a current & working demo of this theme, please check out https://alanpearce.codeberg.page/zola-bearblog/ 🎯.
+
+## Screenshots
+
+⬜️ [Light][light-screenshot]
+
+⬛️ [Dark][dark-screenshot]
+
+When the user's browser is running »dark mode«, the dark color scheme will be used automatically. The default is the light/white color scheme. Check out the [`style.html`](https://codeberg.org/alanpearce/zola-bearblog/src/branch/main/templates/style.html)-file for the implementation.
+
+## Installation
+
+If you already have a Zola site on your machine, you can simply add this theme via
+
+```
+git submodule add https://codeberg.org/alanpearce/zola-bearblog themes/zola-bearblog
+```
+
+Then, adjust the `config.toml` as detailed below.
+
+For more information, read the official [setup guide][zola-setup-guide] of Zola.
+
+## Adjust configuration / config.toml
+
+Please check out the included [config.toml](https://codeberg.org/alanpearce/zola-bearblog/src/branch/main/config.toml)
+
+## Content & structure
+
+### Adding / editing content
+
+#### Index-Page
+
+The contents of the `index`-page may be changed by editing your `content/_index.md`-file.
+
+
+### Adding your branding / colors / css
+
+Add a `custom_head.html`-file to your `templates/`-directory. In there you may add a `<style>`-tag, *or* you may add a `<link>`-tag referencing your own `custom.css` (in case you prefer to have a separate `.css`-file). Check out the [`style.html`](https://codeberg.org/alanpearce/zola-bearblog/src/branch/main/templates/style.html)-file to find out which CSS-styles are applied by default.
+
+## Issues / Feedback / Contributing
+Please use [Codeberg issues](https://codeberg.org/alanpearce/zola-bearblog/issues) and [Pull Requests](https://codeberg.org/alanpearce/zola-bearblog/pulls).
+
+## Special Thanks 🎁
+
+A special thank you goes out to [Herman](https://herman.bearblog.dev), for creating the original [ʕ•ᴥ•ʔ Bear Blog](https://bearblog.dev/) and [Jan Raasch](https://www.janraasch.com) for creating the hugo port of the Bear Blog theme.
+
+## License
+[MIT License](http://en.wikipedia.org/wiki/MIT_License) © [Alan Pearce](https://www.alanpearce.eu/)
+
+[zola-setup-guide]: https://www.getzola.org/documentation/getting-started/installation/
+[light-screenshot]: https://raw.githubusercontent.com/janraasch/zola-bearblog/master/images/screenshot.png
+[dark-screenshot]: https://raw.githubusercontent.com/janraasch/zola-bearblog/master/images/screenshot-dark.png