README.md in jekyll-theme-parallelism-0.1.6 vs README.md in jekyll-theme-parallelism-0.1.7
- old
+ new
@@ -18,10 +18,14 @@
> **GDPR ready**: bundled with a cookie consent plugin and a boilerplate privacy policy compliant with GDPR
> **SEO ready**: sitemap, robots.txt and tags are automatically generated for the website
+> **Light**: svg images, thumbs and lazy loading for raster images, few libraries
+
+> **Hardened**: form validation, recaptcha, verified libraries
+
# Installation
Add this line to your Jekyll site's `Gemfile`:
```ruby
@@ -46,25 +50,39 @@
For those unfamiliar with how Jekyll works, check out [jekyllrb.com](https://jekyllrb.com/) for all the details,
or read up on just the basics of [front matter](https://jekyllrb.com/docs/frontmatter/), [writing posts](https://jekyllrb.com/docs/posts/),
and [creating pages](https://jekyllrb.com/docs/pages/).
+## Initialization
+
+Copy the file `_config.yml` from the theme repository to the root of your website folder tree.
+The following section explains what the settings impact and how to configure `_config.yml` properly.
+
## Configuration
You can use the following custom parameters in `_config.yml`.
### Site
+
Both `title` and `subtitle` are displayed side by side :
- in the tab name
- at the top of the page, in the header
### Social
+
Social icons will appear for each url your fill in, among `facebook_url` etc.
### Contact
+
Your contact information can be used in contact forms, the footer or anywhere else.
+### Recaptcha
+
+The contact form is validated using [google's recaptcha plugin][recaptcha-documentation].
+First, you need to [sign your website up] to enable the plugin.
+Google will provide you with a **client-side integration key**: copy it to `_config.yml` under `recaptcha.sitekey`.
+
## Publication
### On Github Pages
In your own website's repository, edit the `_config.yml` file:
@@ -194,5 +212,7 @@
[cc4-license]: http://choosealicense.com/licenses/cc-by-4.0/
[contributor-covenant]: http://contributor-covenant.org
[cookieconsent]: https://github.com/osano/cookieconsent
[html5up]: https://html5up.net/
[jekyll-logo]: https://github.com/jekyll/brand
+[recaptcha-documentation]: https://developers.google.com/recaptcha/intro
+[recaptcha-registering]: https://www.google.com/recaptcha/admin