Update Readme

[LevytsRoman]

Need a short description of the site,
and setup instructions about how to use it as a jekyll template

[ChaniThakkar]

+1.

The template looks really great. But I get a vanilla page when I hosted it by default.

If steps could be added to README, that should be awesome.

[LevytsRoman]

thanks!

1. bundle install
   should install all necessary gems including sass
2. gem install sass
3. bash sass_watch.ch
   starts sass watching and rebuilding sass into css
4. bundle exec jekyll serve

[ChaniThakkar]

Thanks for the steps above @LevytsRoman. I was able to render the page correctly on my localhost.

How do i make sure that the template renders on github.io though?

[LevytsRoman]

rename your repo to ChaniThakkar.github.io, that should do it, read more here https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/

[ChaniThakkar]

Thanks @LevytsRoman , changing the name worked.
You should add these set of commands to the README.

Thanks for the help again. Good work.

[LevytsRoman]

Np, one more thing,

inside assets/js/transitions.js on line 184 change

this.newContainer.baseURI === "https://levytsroman.github.io/"

to

this.newContainer.baseURI === "https://chanithakkar.github.io/"

and same in assets/js/initialize.js line 124 change

urlString === 'https://levytsroman.github.io/'

to

urlString === 'https://chanithakkar.github.io/'

this will enable the animation where website opens up from homepage, I'll try to make it dynamic in future so thats not something ppl have to do manually

[ChaniThakkar]

sure thing @LevytsRoman. Thanks again :)

[LevytsRoman]

@ChaniThakkar hey forgot to tell you the contact form is powered by https://formspree.io/ you'll have to register(it's free up to 10000 emails or something) and swap my email for yours in assets/js/initialize.js line 19.

[CarlasHub]

Hi Roman, as I contact you before i'm running in the same issue if you get a look would be great Thanks a lot