Initial commit

1 files changed, 57 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..848b682
--- /dev/null
+++ b/README.md
@@ -0,0 +1,57 @@
+# m10c theme
+
+![Intro](images/intro.png)
+
+A Hugo minimalistic theme for bloggers
+
+## Getting started
+
+### Installation
+
+Create a new Hugo site:
+```bash
+$ hugo new site [path]
+```
+
+Clone this repository into `themes/` directory:
+```bash
+$ cd [path]
+$ git clone https://github.com/vaga/hugo-theme-m10c.git themes/m10c
+```
+
+Add this line  in the `config.toml` file:
+```toml
+theme = "m10c"
+```
+
+### Configuration
+
+In your `config.toml` file, define the following variables in `params`:
+- `author`: Name of the author
+- `description`: Short description of the author
+
+To add a social link, add the following lines in `params`:
+```
+[[params.social]]
+  name = "github"
+  url = "https://github.com/vaga"
+```
+
+To change theme colors, add the following lines in `params`:
+```
+[params.style]
+  darkestColor = "#d35050"
+  darkColor = "#212121"
+  lightColor = "#f5e3e0"
+  lightestColor = "#f5f5f5"
+  primaryColor = "#fff"
+```
+If you want the above theme colors, you can see the [exampleSite/config.toml](/exampleSite/config.toml) file.
+
+## License
+
+This theme is released under the [**MIT**](/LICENSE.md) License.
+
+## Aknowledgements
+
+- [feather](https://feathericons.com/) - [MIT](https://github.com/feathericons/feather/blob/master/LICENSE)