From e77f34cefb2dbf7f77993a7a2ec2c59d54363b9b Mon Sep 17 00:00:00 2001
From: Derek Severin <severinderek@gmail.com>
Date: Tue, 11 Sep 2018 15:10:13 +0700
Subject: Readme content updated

---
 README.md | 114 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 112 insertions(+), 2 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 9867cc5..a28f0d0 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,112 @@
-# hugo-myportfolio-theme
-Adaptation of the HUGO Creative Theme to support several portfolios.
+# MyPortfolio Theme
+
+"MyPortfolio Theme" is a portfolio for developers or creatives to showcase their projects.
+It is based on the [HUGO "Creative" Theme](//github.com/digitalcraftsman/hugo-creative-theme) by [digitalcraftsman](//github.com/digitalcraftsman), itself based on the [original Bootstrap theme](//github.com/IronSummitMedia/startbootstrap-creative) by [David Miller](//github.com/davidtmiller).
+
+Noteworthy features of this Hugo theme are:
+- several content sections,
+- responsive portfolio grid with hover effects,
+- dynamic generation of pages based on data content.
+- ...
+
+![Hugo MyPortfolio Theme Screenshot](https://github.com/2-REC/hugo-myportfolio-theme/blob/master/images/screenshot.png)
+
+
+## Installation
+
+Inside the folder of your Hugo site run:
+
+    $ cd themes
+    $ git clone https://github.com/2-REC/hugo-myportfolio-theme
+
+For more information read the official [setup guide](//gohugo.io/overview/installing/) of Hugo.
+
+
+## Getting started
+
+After installing the Creative Theme successfully it requires just a few more steps to get the site running.
+
+
+### The config file
+
+In the [`exampleSite`](//github.com/2-REC/hugo-myportfolio-theme/tree/master/exampleSite) folder of this theme there is a [`config.toml`](
+//github.com/2-REC/hugo-myportfolio-theme/blob/master/exampleSite/config.toml) file.
+
+Copy this file in the root folder of the Hugo site.
+Strings and values can be changed in order to customize the website.
+
+
+### HOME: Set the homepage
+
+!!!! TODO !!!!
+(how to change background)
+
+
+### ABOUT: Introduce yourself
+
+!!!! TODO !!!!
+...
+
+
+### SERVICES: Add your services
+
+!!!! TODO !!!!
+...
+
+
+### SKILLS: Show your skills
+
+!!!! TODO !!!!
+...
+
+
+### PROJECTS: Create a portfolio (or more)
+
+!!!! TODO !!!!
+...
+
+
+### CONTACT: Add contact information
+
+!!!! TODO !!!!
+...
+
+
+### Run the website
+
+In order to see your site in action, run Hugo's built-in local server. 
+
+    $ hugo server
+
+In the browser, enter [`localhost:1313`](http://localhost:1313) in the address bar.
+
+
+## Going further
+
+!!!! TODO !!!!
+(css override, ...?)
+...
+
+
+## Contributing
+
+!!!! TODO !!!!
+Did you found a bug or got an idea for a new feature?
+Feel free to use the [issue tracker](//github.com/...theme.../issues) to let me know.
+Or make directly a [pull request](//github.com/...theme.../pulls).
+
+Please create a separate branch for your pull request.
+
+
+## License
+
+This theme is released under the Apache License 2.0 For more information read the [license](//github.com/2-REC/hugo-myportfolio-theme/blob/master/LICENSE).
+
+
+## Acknowledgements
+
+Thanks to 
+
+- [digitalcraftsman](//github.com/digitalcraftsman) for creating the Creative theme
+- [Steve Francia](//github.com/spf13) for creating Hugo and the awesome community around the project
+- [David Miller](//github.com/davidtmiller) for creating the original theme
-- 
cgit v1.2.3