From aca82c477f98514f1b869982b91ec82cead466a1 Mon Sep 17 00:00:00 2001 From: Mark van Renswoude Date: Wed, 30 Dec 2020 23:29:30 +0100 Subject: [PATCH] Updated readme --- README.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4564ba6..9fd50bf 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,22 @@ + # CuttingBoard -A web-based cutting board designer. +A web-based cutting board designer. Runs fully client-side, designs can be saved by bookmarking the URL or downloading to a JSON file. -## Project setup +If you just want to use it and don't care about the code, go to http://mvrens.github.io/CuttingBoard. + +## Features +- Alternate strips on the end grain board, or customize the direction of each strip individually +- Allows for defining multiple boards with their own layer patterns, which can be combined into one end grain cutting board in any order and direction +- Wood species can be added or customized +- Printing support, with options to select what gets printed to save on paper (and use those trees on cutting boards instead!) +- Units in millimeters, centimeters and inches (decimal - fractional is on the ToDo list) + + +## Developing +This project uses VueJS 3, Vuex and SCSS. + +### Project setup ``` npm install ```