update reacdme, exampleSite

8 files changed, 100 insertions, 96 deletions

diff --git a/LICENSE b/LICENSE
deleted file mode 100644
index faff36e..0000000
--- a/LICENSE
+++ /dev/null
@@ -1,20 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2020 YOUR_NAME_HERE
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
-the Software, and to permit persons to whom the Software is furnished to do so,
-subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
-COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.md b/README.md
index b91a552..4da9bfa 100644
--- a/README.md
+++ b/README.md
@@ -4,85 +4,23 @@ simple theme for hugo
 ![intro](imgaes/img1.png)
 
 # Live Demo
-https://gangjun06.github.io/hugo-theme-simple-intro-demo
+https://gangjun06.github.io/SimpleIntroDemo
 
-[Demo Source Code](https://github.com/gangjun06/hugo-theme-simple-intro-demo)
 
 # Get Started
 
 ```bash
 hugo new site <site-name>
 cd <site-name>
-git submodule add https://github.com/gangjun06/hugo-theme-simple-intro themes/simple-intro
-# Apply config
-hugo serve -D
+git submodule add https://github.com/gangjun06/SimpleIntro themes/SimpleIntro
 ```
 
-config.toml
-```toml
-baseURL = "/"
-languageCode = "en-us"
-theme = "simple-intro"
-title = "Title"
+# Configuration
+Check out the config files included on the [exampleSite](exampleSite)
 
-[params]
-    mainbg = "backroundImage Path"
-    name = "Your Name"
-    mainTitle = "Header Title"
-    mainText = "Header Text"
-
-[menus]
-    [[menu.main]]
-        identifier = "about"
-        name = "About"
-        url = "#about"
-    [[menu.main]]
-        identifier = "skills"
-        name = "Skills"
-        url = "#skills"
-    [[menu.main]]
-        identifier = "projects"
-        name = "Projects"
-        url = "#projects"
-    
-```
-
-data/home/about.toml
-```toml
-title = "about title"
-
-text = """
-about text
-"""
-
-[[link]]
-    icon = "fontawesome icon"
-    link = "#"
-```
-
-data/home/project.toml  
-```toml
-[[list]]
-    title = "project name"
-    image = "Project image"
-    text = """
-    project description
-    """
-```
-
-data/home/skills.toml
-```toml
-[[list]]
-    name = "lang Name"
-    icon = "lang Icon"
-    text = """
-        skill text
-    """
-```
 
 # Credits
 
-| Name                      | License            |
-|---------------------------|--------------------|
-| github.com/gohugoio/hugo  | Apache License 2.0 |
-| github.com/konpa/devicon/ | MIT License        |
\ No newline at end of file
+| Name                      | License     | Description    |
+|---------------------------|-------------|----------------|
+| github.com/konpa/devicon/ | MIT License | Demo Site Icon |
\ No newline at end of file
diff --git a/archetypes/default.md b/archetypes/default.md
index ac36e06..e69de29 100644
--- a/archetypes/default.md
+++ b/archetypes/default.md
@@ -1,2 +0,0 @@
-+++
-+++
diff --git a/exampleSite/config.toml b/exampleSite/config.toml
new file mode 100644
index 0000000..923c9d8
--- /dev/null
+++ b/exampleSite/config.toml
@@ -0,0 +1,25 @@
+baseURL = ""
+languageCode = "en-us"
+theme = "SimpleIntro"
+title = "Theme Demo"
+publishDir = "public"
+
+[params]
+    mainbg = "https://picsum.photos/1920/1080"
+    name = "John Doe"
+    mainTitle = "Simple-intro"
+    mainText = "Just simple intro theme for hugo"
+
+[menus]
+    [[menu.main]]
+        identifier = "about"
+        name = "About"
+        url = "#about"
+    [[menu.main]]
+        identifier = "skills"
+        name = "Skills"
+        url = "#skills"
+    [[menu.main]]
+        identifier = "projects"
+        name = "Projects"
+        url = "#projects"
\ No newline at end of file
diff --git a/exampleSite/data/home/about.toml b/exampleSite/data/home/about.toml
new file mode 100644
index 0000000..8944590
--- /dev/null
+++ b/exampleSite/data/home/about.toml
@@ -0,0 +1,23 @@
+title = "Hello, World!"
+
+text = """
+Lorem ipsum dolor sit amet, consectetur adipisicing elit.
+Voluptatibus quia, nulla! Maiores et perferendis eaque,
+exercitationem praesentium nihil.
+"""
+
+[[link]]
+    icon = "fab fa-github"
+    url = "#"
+[[link]]
+    icon = "fab fa-linkedin"
+    url = "#"
+[[link]]
+    icon = "fas fa-envelope"
+    url = "#"
+[[link]]
+    icon = "fab fa-instagram"
+    url = "#"
+[[link]]
+    icon = "fab fa-facebook"
+    url = "#"
\ No newline at end of file
diff --git a/exampleSite/data/home/project.toml b/exampleSite/data/home/project.toml
new file mode 100644
index 0000000..014ebec
--- /dev/null
+++ b/exampleSite/data/home/project.toml
@@ -0,0 +1,16 @@
+[[list]]
+    title = "lorem"
+    image = "https://picsum.photos/400/200"
+    text = """
+        Lorem ipsum dolor sit amet, consectetur adipisicing elit.
+        Voluptatibus quia, nulla! Maiores et perferendis eaque,
+        exercitationem praesentium nihil.
+    """
+[[list]]
+    title = "lorem"
+    image = "https://picsum.photos/400/200"
+    text = """
+        Lorem ipsum dolor sit amet, consectetur adipisicing elit.
+        Voluptatibus quia, nulla! Maiores et perferendis eaque,
+        exercitationem praesentium nihil.
+    """
\ No newline at end of file
diff --git a/exampleSite/data/home/skills.toml b/exampleSite/data/home/skills.toml
new file mode 100644
index 0000000..9171ae0
--- /dev/null
+++ b/exampleSite/data/home/skills.toml
@@ -0,0 +1,24 @@
+[[list]]
+    name = "go"
+    icon = "https://devicons.github.io/devicon/devicon.git/icons/go/go-original.svg"
+    text = """
+        Lorem ipsum dolor sit amet, consectetur adipisicing elit.
+        Voluptatibus quia, nulla! Maiores et perferendis eaque,
+        exercitationem praesentium nihil.
+    """
+[[list]]
+    name = "React"
+    icon = "https://devicons.github.io/devicon/devicon.git/icons/react/react-original.svg"
+    text = """
+        Lorem ipsum dolor sit amet, consectetur adipisicing elit.
+        Voluptatibus quia, nulla! Maiores et perferendis eaque,
+        exercitationem praesentium nihil.
+    """
+[[list]]
+    name = "C/C++"
+    icon = "https://devicons.github.io/devicon/devicon.git/icons/cplusplus/cplusplus-original.svg"
+    text = """
+        Lorem ipsum dolor sit amet, consectetur adipisicing elit.
+        Voluptatibus quia, nulla! Maiores et perferendis eaque,
+        exercitationem praesentium nihil.
+    """
\ No newline at end of file
diff --git a/theme.toml b/theme.toml
index 600620f..8d9104e 100644
--- a/theme.toml
+++ b/theme.toml
@@ -2,11 +2,11 @@
 # See https://github.com/gohugoio/hugoThemes#themetoml for an example
 
 name = "SimpleIntro"
-license = "MIT"
-licenselink = "https://github.com/yourname/yourtheme/blob/master/LICENSE"
-description = ""
-homepage = "http://example.com/"
-tags = []
+license = "Apache-2.0"
+licenselink = "https://github.com/gangjun06/SimpleIntro/blob/master/LICENSE"
+description = "Simple Single-Page Theme For Hugo"
+homepage = "https://github.com/gangjun06/SimpleIntro"
+tags = ["clean", "simple", "responsive", "light", "single-page", ""]
 features = []
 min_version = "0.41.0"