diff --git a/README.md b/README.md new file mode 100644 index 0000000..c251fe8 --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +# Gokarna + +A minimal opinionated theme for Hugo + +![Gokarna theme](/docs/screenshot.png) + +## Features + +- Minimalistic & fast +- Customizable header +- Responsive +- Light/Dark theme toggle +- Native fonts +- Syntax highlighting +- Math typesetting +- SEO Ready + + +## Inspiration + +The theme is inspired by and accordingly named after [Gokarna](https://en.wikipedia.org/wiki/Gokarna,_Karnataka), a small and peaceful beach town on the west coast on India. + +![Gokarna](/docs/gokarna.jpg) + + +## Installation + +```sh +git submodule add https://github.com/526avijitgupta/gokarna.git themes/gokarna +``` + +## Customization + +- Navbar +- Footer +- Inject html + +## LICENSE + +Apache or MIT ? diff --git a/docs/gokarna.jpg b/docs/gokarna.jpg new file mode 100644 index 0000000..5caa575 Binary files /dev/null and b/docs/gokarna.jpg differ