Update cState v5.0.2

1 files changed, 32 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d73fbf0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+# cState Example Site v5.0.2
+
+This is the default cState status page website directory/folder.
+
+Example site repository link (you are here): https://github.com/cstate/example
+
+Main cState source code repository: https://github.com/cstate/cstate
+
+## Are you updating? Use these commands
+
+Download yoru site with all the directories. `git clone --recursive <your repo link goes here>`
+
+Update the cState theme submodule. `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 <branch, probably main or master>`. Your status page is now updated and uploaded.
+
+
+## For maintainers (probably not for you)
+
+Download this repo with all the directories. `git clone --recursive -b master https://github.com/cstate/example.git`
+
+Make your changes.
+
+Update the cState theme submodule. `git submodule foreach git pull origin master`
+
+Then push `git add -A; git commit -m "Update cState vX.X.X"; git push origin master`.
+
+## License
+
+MIT © Mantas Vilčinskas
\ No newline at end of file