add project

1 files changed, 29 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ef140b2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# base16-btop
+
+<!-- markdownlint-disable MD013 -->
+
+This repo provides templates for using [Base16](https://github.com/tinted-theming/home) color schemes with [btop](https://github.com/aristocratos/btop), a monitor of resources.
+
+All files in `colors` directory generated by [lustache](https://luarocks.org/modules/olivine-labs/lustache) and [lustache-cli](https://github.com/djmattyg007/lustache-cli).
+
+## Examples
+
+### base16-onedark
+
+![Example nwg-dock with base16-onedark colorscheme](./examples/img/onedark.png)
+
+### base16-google-light
+
+![Example nwg-dock with base16-google-light colorscheme](./examples/img/google-light.png)
+
+## Usage
+
+You can find an example config in `examples/onedark.theme`.
+
+> User created themes should be placed in $XDG_CONFIG_HOME/btop/themes or $HOME/.config/btop/themes.
+
+[Read More](https://github.com/aristocratos/btop?tab=readme-ov-file#themes)
+
+## License
+
+MIT