Update README.md

This commit is contained in:
Oliver Davies 2018-07-22 20:01:57 +01:00
parent e286a83c26
commit 94720527bd

View file

@ -1,17 +1,29 @@
# [Cardiff BJJ website][4]
# Cardiff BJJ
Website for the [Rob Taylor Jiu-Jitsu Academy][4].
Built with [Sculpin][0] and [Tailwind CSS][1] by [Oliver Davies][2].
Hosted on [Netlify][3].
## Install
## Prerequisites
- PHP
- Composer
- Yarn
## Setup
```bash
$ composer install
git clone https://github.com/cardiff-bjj/website cardiff-bjj
cd cardiff-bjj
composer install
yarn install
```
## Build
```bash
yarn watch
vendor/bin/sculpin generate --watch --server
```