added README.md

1 files changed, 37 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3f93328
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+# Nix
+
+Nix is a simple, minimal theme for Hugo
+
+## Usage
+
+Clone the repository to your hugo theme directory
+
+```
+mkdir themes
+cd themes
+git clone https://github.com/LordMathis/hugo-theme-nix
+```
+
+## Configuration
+
+Add these parameters to your `config.toml`:
+
+```
+[params]
+  GithubID = "your_github"
+	TwitterID = "your_twitter"
+	LinkedInID = "your_linkedin"
+	GoogleplusID = "your_googleplus"
+	FacebookID = "your_facebook"
+	SelfName = "your_name"
+	HeaderUsername = "username"
+	HeaderHostname = "hostname"
+	Email = "your_email"
+	About = "info_about_you"
+```
+
+Edit them as needed. If you don't want one of the social networks simply delete that line. `HeaderUsername` and `HeaderHostname` will be displayed in navbar on left side in the format: `HeaderUsername@HeaderHostname ~ $`
+
+## License
+
+Nix is licensed under the [MIT License](LICENSE.md)