README.md in jekyll-theme-omega-0.2.5 vs README.md in jekyll-theme-omega-0.2.6

@@ -1,52 +1,84 @@
-# dryx-theme
 
-Welcome to your new Jekyll theme! In this directory, you'll find the files you need to be able to package up your theme into a gem. Put your layouts in `_layouts`, your includes in `_includes`, your sass files in `_sass` and any other assets in `assets`.
+# Jekyll Omega Theme 
 
-To experiment with this code, add some sample content and run `bundle exec jekyll serve` – this directory is setup just like a Jekyll site!
+Here I've lifted the excellent [HMFAYSAL OMEGA theme](https://github.com/hmfaysal/hmfaysal-omega-theme), added a few tweaks and packaged it up as a gem-based theme.
 
-TODO: Delete this and the text above, and describe your gem
+## Installation and Usage
 
+To create a new website using the theme first grab the default folder structure and files:
 
-## Installation
+```bash
+wget https://github.com/thespacedoctor/hmfaysal-omega-jekyll-theme/archive/master.zip
+unzip master.zip
+mv hmfaysal-omega-jekyll-theme-master my-new-website
+cd my-new-website/
+```
 
-Add this line to your Jekyll site's `Gemfile`:
+Now run the provided script to clean up those files:
 
-```ruby
-gem "dryx-theme"
+```bash
+sh init_setup.sh
 ```
 
-And add this line to your Jekyll site's `_config.yml`:
+and follow the prompts.
 
-```yaml
-theme: dryx-theme
+## Serving and Building
+
+To serve the Jekyll site on your local machine run the following:
+
+```bash
+bundle exec jekyll serve
 ```
 
-And then execute:
+and open your browser at the URL stated in the command-line outout (try chaning `127.0.0.1` to `localhost` in the URL if assests are not getting rendered).
 
-    $ bundle
+To build the production version of your site run:
 
-Or install it yourself as:
+```bash
+bundle exec jekyll build -d /path/to/build/folder
+```
 
-    $ gem install dryx-theme
+## Running in Development Mode with Apache
 
-## Usage
+If you have Apache setup on your local machine to host a development version of your Jekyll site you will need to have the `site.url` parameter set to `localhost` to source all of your assests correctly. To do this by overriding the production `site.url` run the following:
 
-TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.
+```bash
+bundle exec jekyll build --config _config.yml,_config_dev.yml
+```
 
-## Contributing
+## Creating a Password Protected Version of Your Site
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hello. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+You can now create a second version of your site that sits behind basic authentication (if you're hosting with Apache). To do so you first need to create a .htpasswd file with the password you want by running the follow command from the root directory of your Jekyll source and giving a good strong password.
 
-## Development
+```bash
+htpasswd -c .htpasswd guest
+```
 
-To set up your environment to develop this theme, run `bundle install`.
+Once you have your password set run the build commands in the following order:
 
-Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
+```bash
+bundle exec jekyll build
+bundle exec jekyll build --config _config.yml, --destination _site/protected --unpublished --baseurl=/protected
+```
 
-When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.
-To add a custom directory to your theme-gem, please edit the regexp in `dryx-theme.gemspec` accordingly.
+Now when you go the the `/protected` subpath of your domain you will be prompted for a user and password. Any posts with the front-matter `published: false` will be found in the protected version of your site but not the public version. Niffty.
 
-## License
+Note: make sure that you have `AllowOverride AuthConfig` within a Directory tag in either a VirtualHost or your httpd config file to allow the `.htaccess` file to alter the authentication settings for the directory it lives in.
 
-The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+```text
+<VirtualHost *:80>
+      ...
+
+      <Directory /path/to/my/_site>
+        Options FollowSymLinks Includes Indexes
+        Require all granted
+        AllowOverride AuthConfig
+      </Directory>
+
+      ...
+</VirtualHost>
+```
+
+
+