diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 75 |
1 files changed, 44 insertions, 31 deletions
@@ -1,43 +1,53 @@ -<p align="center"><img src="https://raw.githubusercontent.com/cstate/cstate/master/images/highlight.png" alt="cState"></p> +<p align="center"><img src="https://raw.githubusercontent.com/cstate/cstate/master/images/highlight.svg" alt="Example of what cState looks like"></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/matiassingers/awesome-readme#readme"><img src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg" alt="Awesome README" /></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/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> -> Ü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 & GitHub Pages. -[**Want an example? Click here to see a live demo!**](https://cstate-example.netlify.com) +[**🎯 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) +[👩💻 You can also see what an example cState project’s source code.](https://github.com/cstate/example) -*Looking for contributors! See Contribute section:* +## Contents ⁉ -## Contents - -+ [Features](#features) -+ Getting started ++ [Features](#features-) ++ [Getting started](#getting-started-) + [Production](#production) + [Development](#development) -+ [Updating](#updating) -+ [FAQ](#faq) -+ [Contribute](#contribute) -+ [License](#license) ++ [Updating](#updating-) ++ [FAQ](#faq-) ++ [Contribute](#contribute-) ++ [License](#license-) *** -## Features +## Features 😎 + +**Designed with care** -+ Built with [Hugo](https://gohugo.io), a hyperfast Golang generator -+ Works not just on mobile, but also on the archaic Internet Explorer 8 + Comes with a simple, focused, and extremely light design ++ 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 + +**Fast, reliable, and free** + ++ Built with [Hugo](https://gohugo.io), a hyperfast Golang generator ++ Secure, ready for HTTPS, thanks to [JAMstack](https://jamstack.org/) ++ Easy to edit and deploy on Netlify for _absolutely free_ + +**Easy to setup, manage, use** + + Edit your status page from a simple config file + Comes pre-equipped with Netlify CMS for quick admin updates -+ Easy to edit and deploy on Netlify or GitHub Pages -+ Secure, ready for HTTPS, thanks to [JAMstack](https://jamstack.org/) + Extensive documentation on the [wiki](https://github.com/cstate/cstate/wiki) -## Getting started +## Getting started 💻 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. + #### Production We encourage you to use [Netlify](https://www.netlify.com) for cState. These are the following options you need to change in deploy settings: @@ -46,7 +56,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.41** + + Value: **0.48** **The easy way** @@ -86,20 +96,20 @@ git clone https://github.com/cstate/cstate.git 2. Navigate to the theme directory: ```bash -cd cstate-master +cd cstate/exampleSite ``` 3. Launch the development setup much like this: ```bash -hugo serve --baseUrl=/ --theme=cstate-master --themesDir=../.. +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 deploying to production! If you would like to commit/make a PR, make sure that `themesDir` is a comment before trying to merge upstream. -## Updating +## 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. @@ -117,7 +127,7 @@ git clone --recursive <your repo link goes here> && git submodule foreach git pu More info about submodules on [updating](https://stackoverflow.com/a/5828396) & [cloning](https://stackoverflow.com/questions/3796927/how-to-git-clone-including-submodules). -## FAQ +## FAQ 🤔 ### Where do issues go? @@ -127,7 +137,7 @@ This takes a little more effort to set up but pays off in the long run — [see #### Doing it from the Git repository -Create a file in `content/issues`. The name of the file will be the slug (what shows up in the URL bar). For example, this is what `major-outage-east-us.md` should look like: +Create a file in `content/issues`. The name of the file will be the slug (what shows up in the URL bar). For example, this is what `2017-02-30-major-outage-east-us.md` should look like: ```md --- @@ -160,15 +170,18 @@ Time to break that down. Check out [the wiki](https://github.com/cstate/cstate/wiki). -## Contribute +## Contribute 💥 -cState needs help to grow, not only would it benefit from stuff like unit tests, but also get influenced by fresh ideas to grow even further. +> Want to become a maintainer? Hit me up! [@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. -+ You may also use the mnts [Discord chat](https://discord.gg/EvQZdhT) for support. ++ Version numbers should be added in JS partial & meta generator tags! + +## License ✍ -## License +[MIT](https://github.com/cstate/cstate/blob/master/LICENSE.md) © [Mantas Vilčinskas](https://github.com/mistermantas) -[MIT](https://github.com/cstate/cstate/blob/master/LICENSE.md) © Mantas Vilčinskas +Thanks to all the [contributors](https://github.com/cstate/cstate/graphs/contributors)! |