diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 25 |
1 files changed, 21 insertions, 4 deletions
@@ -1,6 +1,6 @@ <p align="center"><img src="https://raw.githubusercontent.com/cstate/cstate/master/images/highlight.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/EvQZdhT"><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&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"><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&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> > Über fast, backwards compatible (IE8+), tiny, and simple status page built with Hugo. Completely _free_ with Netlify & GitHub Pages. @@ -17,6 +17,7 @@ + [Updating](#updating-) + [FAQ](#faq-) + [Contribute](#contribute-) +* [Donate](#donate-) + [License](#license-) *** @@ -29,8 +30,9 @@ + Works not just on mobile, but also on the archaic Internet Explorer 8 + Makes you accountable, showcasing how long it took for an issue to be resolved + Great for data manipulation and viewing — has RSS, tag-like system feeds ++ Customizable views, colors, and other elements -**Fast, reliable, and free** +**Fast, reliable, and free (even to host)** + Built with [Hugo](https://gohugo.io), a hyperfast Golang generator + Secure, ready for HTTPS, thanks to [JAMstack](https://jamstack.org/) @@ -41,6 +43,7 @@ + Edit your status page from a simple config file + Comes pre-equipped with Netlify CMS for quick admin updates + Extensive documentation on the [wiki](https://github.com/cstate/cstate/wiki) ++ [Read-only API available](https://github.com/cstate/cstate/wiki/API) ## Getting started 💻 @@ -56,7 +59,7 @@ We encourage you to use [Netlify](https://www.netlify.com) for cState. These are + Publish directory: **public** + Add one build environment variable + Key: **HUGO_VERSION** - + Value: **0.48** + + Value: **0.48** (or later) **The easy way** @@ -76,6 +79,11 @@ If you want to do this from any branch in this repository, follow the manual ins ```bash mkdir themes; cd themes; ``` +2. Start Git on this folder: + +```bash +git init +``` 3. Now simply add a Git submodule pointing to this repository, like so: @@ -90,7 +98,7 @@ git submodule add https://github.com/cstate/cstate 1. Clone this repository in the command line: ```bash -git clone https://github.com/cstate/cstate.git +git clone --recurisve https://github.com/cstate/cstate.git ``` 2. Navigate to the theme directory: @@ -170,6 +178,15 @@ Time to break that down. Check out [the wiki](https://github.com/cstate/cstate/wiki). +## Donate ❤️ + +cState is only a hobby project of @mistermantas, but it’s a prideful one. + +Support the developer and ensure the future of the project by donating for a cuppa tea, some ice cream, or if you are feeling generous — a large size pizza. + +* [PayPal](https://paypal.me/AlbinaV} +* or you can make a bank transfer. For info, [get in touch](https://mnts.lt) + ## Contribute 💥 > Want to become a maintainer? Hit me up! [@mistermantas](https://twitter.com/mistermantas) |