added readme and updated theme description

2 files changed, 29 insertions, 1 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0a4beaa
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# Simple Resume Theme
+This theme is meant to create a web based, simple resume, that you can print.
+
+![Screenshot](images/screenshot.png)
+
+# Features
+ - Web based resume
+ - Printable
+ - Straightforward/simple design
+
+# Install theme on your hugo site
+```
+hugo new site your-site-name # if you already have a site ignore this line and the next
+cd your-site-name
+cd themes
+git clone https://github.com/tylerjlawson/simple-resume.git
+``` 
+Once you have done this, you may use the `exampleSite` folder as an example for how to set your project up. The two main things to pay attention to is to first set this in your `config.toml` file:
+```toml
+theme = "simple-resume"
+```
+Then you will need to replicate the data used in the `exampleSite/data/content.toml` file to fill in the fields for your resume.
+
+## Print your Resume
+You can print the page straight to a pdf or to paper if you wish. I have had best luck printing with the margins set to 'minimum', but you can set custom margins when printing if it looks off to you.
+
+# Contributing 
+Please feel free to post issues or make pull requests at any time. I am always open to collaboration.
\ No newline at end of file
diff --git a/theme.toml b/theme.toml
index 0676abd..2bf7c2d 100644
--- a/theme.toml
+++ b/theme.toml
@@ -1,7 +1,7 @@
 name = "Simple Resume"
 license = "MIT"
 licenselink = "https://github.com/tylerjlawson/simple-resume/blob/master/LICENSE"
-description = ""
+description = "This is a simple resume that you can print or host on the web"
 homepage = "https://github.com/tylerjlawson/simple-resume/"
 tags = ["cv", "resume", "minimalist"]
 min_version = "0.41.0"