diff --git a/README.md b/README.md index b33e5b1..585809c 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,17 @@ # TWC The Netherlands [![Netlify Status][netlify_bagde]][netlify_url] -[![website][website_badge]][website_url] -[![production][production_badge]][production_url] [![Code style][code_style_badge]][code_style_url] [![Twitter: nederlandtwc][twitter_badge]][twitter_url] +[![website][website_badge]][website_url] +[![production][production_badge]][production_url] [![i18n-en][i18n_en_badge]][i18n_en_url] [![i18n-nl][i18n_nl_badge]][i18n_nl_url] > This repository is responsible for most content visible on the website [techwerkers.nl](https://techwerkers.nl). The site is made with a static site generator called [Jekyll](https://jekyllrb.com/) in a language called Ruby. -## Install +## 🛠️ Installation Read the [installation guide](./docs/contributing.md) to get set up. diff --git a/docs/contributing.md b/docs/contributing.md index 1ab3bd1..e2fa9bb 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -1,4 +1,4 @@ -# Contributing +# 🤝 Contributing ## Add an event diff --git a/docs/installation.md b/docs/installation.md index 1232938..7fb20e4 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -1,14 +1,15 @@ -# Installation +# 🛠️ Installation ## Formatting Install prettier and precommit hooks: `npm install` + You can manually run prettier using: `npx prettier . --write` ### Skip pre-commit hooks 1. To skip pre-commit hooks, use `git commit --no-verify` or `git commit -n` -1. Alternatively, you could not run `npm install`; opting to install prettier and the plugin globally `npm install -g prettier @shopify/prettier-plugin-liquid`` +1. Alternatively, you could not run `npm install`; opting to install prettier and the plugin globally via `npm install -g prettier @shopify/prettier-plugin-liquid` ## With Docker (recommended)