diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 78 |
1 files changed, 58 insertions, 20 deletions
@@ -1,13 +1,24 @@ <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. +> Über fast, backwards compatible (IE8+), tiny, and simple status page built with Hugo. Completely _free_ with Netlify, Netlify CMS. [**🎯 Want an example? Click here to see a live demo!**](https://cstate-example.netlify.com) [👩💻 You can also see what an example cState project’s source code.](https://github.com/cstate/example) +## Who uses cState? 🥳 + +Some more examples from the internet: + +* [Chocolatey](https://status.chocolatey.org/) +* [Proventa](https://status.proventa.io/) (German) +* [sr.ht](https://status.sr.ht/) +* [Content Ignite](https://status.contentignite.com/) + +*Want your status page here? [Create a Pull Request](https://github.com/cstate/cstate/edit/dev/README.md)!* + ## Contents ⁉ + [Features](#features-) @@ -17,6 +28,7 @@ + [Updating](#updating-) + [FAQ](#faq-) + [Contribute](#contribute-) +* [Support](#support-) + [License](#license-) *** @@ -25,15 +37,17 @@ **Designed with care** +* **New in v4**: automatically ships with dark mode + Comes with a simple, focused, and extremely light design -+ Works not just on mobile, but also on the archaic Internet Explorer 8 ++ Works not just on mobile, but also on the archaic Internet Explorer 8 for some reason + 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, HTML, 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/) ++ Secure, ready for HTTPS; see [JAMstack](https://jamstack.org/) + Easy to edit and deploy on Netlify for _absolutely free_ **Easy to setup, manage, use** @@ -41,6 +55,8 @@ + 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) ++ You can not only create issues, but also informational, about pages ++ **New in v4**: [Read-only API available](https://github.com/cstate/cstate/wiki/API) ## Getting started 💻 @@ -56,7 +72,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 +92,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 +111,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 --recursive -b master https://github.com/cstate/cstate.git ``` 2. Navigate to the theme directory: @@ -111,24 +132,28 @@ If you would like to commit/make a PR, make sure that `themesDir` is a comment b ## Updating 🎉 -Assuming the production install instructions were followed, keep cState updated by having an up to date Git submodule in the `themes` folder. containing this repository. Your content will stay separate, as to avoid any conflicts. +**If you are updating from one major version to another, like from v3 to v4, then please [read the migration guides](https://github.com/cstate/cstate/wiki/Usage#migration-guides).** -If you already have a Git repository set up with a filled up `themes/cstate` folder, then all you need to do is this: +Assuming the production install instructions were followed, keep cState updated by having an up to date Git submodule in the `themes` folder. containing this repository. Your content will stay separate. -```bash -git submodule foreach git pull origin master -``` +Ask yourself these questions: -If you have previously used Netlfiy CMS or have made other changes without using the command line, the easiest thing to do is just clone it in a new place, change it how you want to, push those changes, and then you can safely remove the Git folder. So, do this: +1. Do I already have the **up to date** Git repository with my status page on my computer? + * If not, go to your desktop or somewhere else, where you can download your Git repository and run: `git clone --recursive <your repo link goes here> && git submodule foreach git pull origin master`. + * In the parent directory, type `hugo serve`. Check to see if everything is working. + * Then do `git add -A; git commit -m "Update cState"; git push origin master; exit`. Your status page is now updated. +2. If you **DO** have the directory, go inside `themes/cstate`. If that is empty, it is easier to delete your local copy and do the steps outlined earlier. -```bash -git clone --recursive <your repo link goes here> && git submodule foreach git pull origin master -``` +There is currently no easier way to do this, unfortunately, you will need the terminal / command line / Git Bash, unless you want to create a new status page from scratch and move your data over manually. -More info about submodules on [updating](https://stackoverflow.com/a/5828396) & [cloning](https://stackoverflow.com/questions/3796927/how-to-git-clone-including-submodules). +More info about submodules: [updating](https://stackoverflow.com/a/5828396) & [cloning](https://stackoverflow.com/questions/3796927/how-to-git-clone-including-submodules). ## FAQ 🤔 +### Are there settings you can change? + +Yes, most of the settings are in the `config.yml` file or under _Settings_ in Netlify CMS. + ### Where do issues go? #### Using an admin panel (Netlify CMS) @@ -170,15 +195,28 @@ Time to break that down. Check out [the wiki](https://github.com/cstate/cstate/wiki). +## Support ❤️ + +cState is only a hobby project of @mistermantas, but it has turned into something a little bit bigger. + +Please **star, share, and use the software**. Thank you, if you do. + +If you wish to support the project financially: + +[Sponsor the author @mistermantas on GitHub](https://github.com/sponsors/mistermantas) + +[Support the author on PayPal](https://www.paypal.me/mistermantas) + + ## Contribute 💥 -> Want to become a maintainer? Hit me up! [@mistermantas](https://twitter.com/mistermantas) +> Want to become a maintainer? Hit me up [on Twitter @mistermantas](https://twitter.com/mistermantas) + Glance over the [Code of Conduct](/CODE_OF_CONDUCT.md). + Before submitting a pull request, create an issue to [discuss the implications of your proposal](https://github.com/cstate/cstate/issues). + Or if you are a translator — [see this](https://github.com/cstate/cstate/wiki/Translations#add-your-translations). -+ Write consistent, simple, readable code and precise documentation. -+ Version numbers should be added in JS partial & meta generator tags! ++ Write consistent, simple, readable code, and precise documentation. ++ Version numbers should be added in the JS partial, the meta[generator] tag, and API index! ## License ✍ |