v5 goes live - #151

1 files changed, 62 insertions, 54 deletions

diff --git a/README.md b/README.md
index b7414a9..098500a 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,12 @@
-<p align="center"><img src="images/cstate-logo-bg.svg?sanitize=true" alt="cState example illustration"></p>
-
-<p align="center"><a href="https://github.com/cstate/cstate/releases"><img src="https://img.shields.io/github/release/cstate/cstate/all.svg?style=flat-square" alt="GitHub release" /></a> <a href="https://github.com/cstate/cstate/commits/master"><img src="https://img.shields.io/github/last-commit/cstate/cstate.svg?style=flat-square" alt="GitHub last commit" /></a> <a href="https://github.com/cstate/cstate/tree/master/"><img src="https://img.shields.io/github/repo-size/cstate/cstate.svg?style=flat-square" alt="GitHub repo size in bytes" /></a> <a href="https://discord.gg/zYCjzys"><img src="https://img.shields.io/badge/discord-support-7289DA.svg?logo=discord&style=flat-square" alt="Discord Chat" /></a> <a href="https://twitter.com/cstate"><img src="https://img.shields.io/twitter/follow/mistermantas.svg?style=social&amp;label=Follow" alt="Twitter" /></a> <a href="https://github.com/ivbeg/awesome-status-pages"><img src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg" alt="Awesome status page" /></a></p>
+<p align="center"><img src="images/cstate-logo-bg.svg?sanitize=true" width="500" height="auto" alt="cState example illustration"></p>
 
 > Über fast, backwards compatible (IE8+), tiny, and simple status page built with Hugo. Completely _free_ with Netlify. Comes with Netlify CMS, read-only API, and other useful features.
 
-## Sponsors 🏅
-
-<a href="//statuspal.io"><img src="images/statuspal-logo-with-text.png" alt="Statuspal" width="200"></a>
+<a href="https://github.com/cstate/cstate/commits/master"><img src="https://img.shields.io/github/last-commit/cstate/cstate.svg?style=flat-square" alt="GitHub last commit" /></a>  <a href="https://github.com/ivbeg/awesome-status-pages"><img src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg" alt="Awesome status page" /></a>
 
-You can also support the creator of this project by **starring, sharing, and using cState**. Thank you!
+<a href="//statuspal.io">Sponsored by <img src="images/statuspal-logo-with-text.png" alt="Statuspal" width="150"></a>
 
-[*Learn more about sponsorships*](https://github.com/sponsors/mistermantas)
+You can also support the creator of this project by **starring, sharing, using cState and/or [financially supporting the author](https://github.com/sponsors/mistermantas)**. Thank you!
 
 ## Examples 🥳
 
@@ -30,6 +26,8 @@ You can also support the creator of this project by **starring, sharing, and usi
 * [Content Ignite](https://status.contentignite.com/)
 * [FSCI](https://status.fsci.in/)
 * [Storehouse](https://status.sthse.co)
+* [Hyrousek](https://status.hyrousek.tk)
+* [josh.win](https://status.josh.win)
 
 *Want your status page here? [Create a PR](https://github.com/cstate/cstate/edit/dev/README.md)!*
 
@@ -57,6 +55,8 @@ There are other commercial options that may update faster because of their archi
 
 ### List of possibilities
 
+**Please note that with all that cState _can_ do, it cannot do automatic monitoring. [See this thread](https://github.com/cstate/cstate/issues/124)**
+
 | **cState is designed with care**                                                                                         	| **Fast, reliable, and free (even with host)**                                                                            	| **Easy to setup, manage, use**                                                                                                                           	|
 |--------------------------------------------------------------------------------------------------------------------------	|--------------------------------------------------------------------------------------------------------------------------	|----------------------------------------------------------------------------------------------------------------------------------------------------------	|
 | A simple and focused user interface & experience with [instant loading](https://github.com/cstate/cstate/issues/117), suitable for any brand                            	| Built with [Hugo](https://gohugo.io), a hyperfast Golang static site generator (SSG)                                     	| As easy as WordPress: if you don't like getting into the code, try Netlify CMS                                                                           	|
@@ -71,10 +71,9 @@ There are other commercial options that may update faster because of their archi
 ## Getting started 💻
 
 This is how you create a **new site powered by cState.**  What you are generating is a Hugo site with specific, already existing modifications (to Hugo, cState is a theme).
+ 
 
-### — The easy way —
-
-#### 💚 Netlify and Netlify CMS
+### 💚 Netlify and Netlify CMS
 
 cState was built to work best with Netlify and comes with the neccesary files to enable Netlify CMS.
 
@@ -99,38 +98,49 @@ These are the settings you should be using:
 + Publish directory: **public**
 + Add one build environment variable
   + Key: **HUGO_VERSION**
-  + Value: **0.48** (or later)
+  + Value: **0.80** (or later)
++ Also **for the Build image selection, pick Ubuntu Xenial 16.04 or later**
 
+### 🧡 Other great hosting and CMS options
 
-#### 🧡 GitLab Pages (Experimental)
+The most popular options, apart from Netlify's offers, are:
 
-GitLab Pages, unlike GitHub Pages, supports Hugo, so you can let GitLab build and serve cState without needing to do it on your own machine ([similarly to how you can blog with GitLab Pages from your phone](https://about.gitlab.com/blog/2016/08/19/posting-to-your-gitlab-pages-blog-from-ios/)).
+* **Hosting:**
+    * GitHub Pages
+    * GitLab Pages
+    * Cloudflare Pages
+    * Vercel
+* **Admin panels / CMS:**
+    * Forestry.io
+    * Or just use your Git provider (github.com, gitlab.com, etc)
 
-[GitLab has a good guide for getting started with GitLab Pages in their documentation.](https://docs.gitlab.com/ee/user/project/pages/#getting-started)
+You can also look at [other headless CMS options **(we use Git-based CMS types)** on jamstack.org](https://jamstack.org/headless-cms/).
 
-**In short: a `.gitlab-ci.yml` file** is responsible for making cState work. As of v4.2.1, the [cState automatically ships with this file](https://github.com/cstate/cstate/releases/tag/v4.2.1).
+### GitLab Pages
 
-As of this time, this is a relatively untested option, but Hugo does seem to generate the right things (this can be checked by downloading the **CI/CD artificats**).
+Here is a [good guide for getting started with the service.](https://docs.gitlab.com/ee/user/project/pages/#getting-started)
 
-According to GitLab, it may take up to 30 minutes before the site is available after the first deployment.
+**In short: a `.gitlab-ci.yml` file** is responsible for making cState work. As of v4.2.1, the [cState automatically ships with this file](https://github.com/cstate/cstate/releases/tag/v4.2.1), but support is still experimental.
 
-You can [make Netlify CMS work on GitLab](https://www.netlifycms.org/docs/gitlab-backend/), but that requires overriding an existing file in the theme. Create a file in `static/admin/config.yml` and follow the instructions linked earlier. (cState by default ships with Git Gateway.)
+As of this time, this is a relatively untested option, but Hugo does seem to generate the right things (this can be checked by downloading the **CI/CD artificats**).
 
+According to GitLab, it may take up to 30 minutes before the site is available after the first deployment.
 
-#### 🖤 Other platforms
+You can [make Netlify CMS work on GitLab](https://www.netlifycms.org/docs/gitlab-backend/), but that requires overriding an existing file in the theme. Create a file in `static/admin/config.yml` and follow the instructions linked earlier. (cState by default ships with Git Gateway for Netlify.)
 
-At this time, as of the author's knowledge, there are no other platforms that support 'easy' deployment (if you know any — [let us know](#contribute-)).
+### GitHub Pages, Cloudflare Pages, Vercel, Forestry, and others
 
-Keep reading to see how to deploy manually.
+There is no official, separate documentation for these, but if you look below to see how to deploy manually, the instructions will be the same everywhere.
 
+### Doing it on your PC
 
+Keep reading to see how to deploy manually. Developers wishing to contribute, scroll to the very bottom.
 
-### — Manual builds —
+### Manual builds
 
 For this tutorial, it is assumed that you have Hugo and Git installed (check with `hugo version` & `git --version`).
 
-> A minimum version of `0.48` is required for Hugo, starting with v3.
-
+> A minimum version of `0.80` is required for Hugo, starting with v5.
 
 #### I want to use my site in production
 
@@ -158,31 +168,7 @@ And the folder `public` can now be hosted.
 
 The downside with manual building is that, if you do not want to use a solution like GitLab Pages or Netlify, this process will need to happen on your computer. This can be tedious.
 
-
-#### I want to contribute to the development
-
-1. Clone this repository in the command line:
-
-```bash
-git clone --recursive -b master https://github.com/cstate/cstate.git
-```
-
-2. Navigate to the theme directory:
-
-```bash
-cd cstate/exampleSite
-```
-
-3. Launch the development setup like this:
-
-```bash
-hugo serve --baseUrl=http://localhost/ --theme=cstate --themesDir=../.. --verbose
-```
-
-The main directory is the theme itself (the cState guts, basically) and the `exampleSite` folder houses all content. Use this local setup to experiment before making a PR.
-
-
-### — Docker —
+### Docker
 
 cState comes with a Dockerfile and Netlify ([according to their article from 2016](https://www.netlify.com/blog/2016/10/18/how-our-build-bots-build-sites/)) uses a similar Docker system to build cState. This is an option for people who prefer Docker and NGINX instead of serverless, but serverless still has the priority in our development. 
 
@@ -277,21 +263,43 @@ Check out [the wiki](https://github.com/cstate/cstate/wiki).
 
 ## Contribute 💥
 
-**Making a change in the code**
+### Making a change in the code
 
 PRs should be submitted to the `dev` branch, if it exists. Before submitting a pull request, create an issue to [discuss the implications of your proposal](https://github.com/cstate/cstate/issues).
 
-**For translators**
+Here is a guide for how you should develop:
+
+1. Clone this repository in the command line:
+
+```bash
+git clone --recursive -b master https://github.com/cstate/cstate.git
+```
+
+2. Navigate to the theme directory:
+
+```bash
+cd cstate/exampleSite
+```
+
+3. Launch the development setup like this:
+
+```bash
+hugo serve --baseUrl=http://localhost/ --theme=cstate --themesDir=../.. --verbose
+```
+
+The main directory is the theme itself (the cState guts, basically) and the `exampleSite` folder houses all content. Use this local setup to experiment before making a PR.
+
+### For translators
 
 [See this](https://github.com/cstate/cstate/wiki/Translations#add-your-translations).
 
-**Code of conduct**
+### Code of conduct
 
 [Be kind](/CODE_OF_CONDUCT.md).
 
 ## License ✍
 
-[MIT](https://github.com/cstate/cstate/blob/master/LICENSE.md) © [Mantas Vilčinskas](https://mnts.lt)
+[MIT](https://github.com/cstate/cstate/blob/master/LICENSE.md) © [Mantas Vilčinskas](https://vilcinskas.me)
 
 A special thanks to all [the contributors](https://github.com/cstate/cstate/graphs/contributors)