Merge pull request #60 from shibumi/shibumi/fix-documentation1.3.1

fixed docs and added styleguide

2 files changed, 14 insertions, 1 deletions

diff --git a/README.md b/README.md
index 4843f84..0c5f8d7 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
 # arch-boxes
-[![Actions Status](https://github.com/archlinux/arch-boxes/workflows/CI/badge.svg)](https://github.com/archlinux/arch-boxes/actions)
+[![Actions Status](https://github.com/archlinux/arch-boxes/workflows/Github-Actions/badge.svg)](https://github.com/archlinux/arch-boxes/actions)
 
 Arch-boxes provides automated builds of the Arch Linux releases for
 different providers and post-processors. Check the providers or post-processor sections if you want to know
diff --git a/STYLEGUIDE.md b/STYLEGUIDE.md
new file mode 100644
index 0000000..737f8ff
--- /dev/null
+++ b/STYLEGUIDE.md
@@ -0,0 +1,13 @@
+# Styleguide
+
+## Python
+
+All python scripts must be formatted with `yapf` and checked for errors and pep8 with `flake8`.
+
+## Bash
+
+All shell scripts must be formatted with `shfmt -i2 -ci` and be syntax checked via `shellcheck`.
+
+## Vagrant
+
+Vagrant json configuration has to be checked with `packer validate`.