From e0c39513da694deb79d5235b4078e3b6d39a7267 Mon Sep 17 00:00:00 2001 From: krikienoid Date: Sun, 19 Feb 2023 11:00:23 -0500 Subject: [PATCH] Update README --- README.md | 22 ++++++++-------------- 1 file changed, 8 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 5ef5f10..8796c28 100644 --- a/README.md +++ b/README.md @@ -4,25 +4,19 @@ [krikienoid.github.io/flagwaver](https://krikienoid.github.io/flagwaver/) -## Features +## Description -- Upload images from the web or from your device. -- Supports flag cloths with different aspect ratios. -- Set the hoist side and flag orientation. -- Try out different flagpoles. -- Adjust wind speed and direction. -- Progressive Web App support. +FlagWaver is a web app that lets you upload your own image and turn it into a flag. It is a visualization tool that simulates a waving flag in 3D. You can change the hoist direction, wind, background, and more. + +See the [wiki](https://github.com/krikienoid/flagwaver/wiki) for details. ## Development -This project uses a Gulp-powered build system with these features: +This project uses a Gulp powered build system to manage tasks such as transpilation and minification. Code files from the ```src``` directory are compiled and output to the ```dist``` directory. + +**Dev tools** - Gulp, Rollup, Babel, Terser, Sass, Autoprefixer, clean-css -- Sass compilation and prefixing -- Rollup JavaScript bundler -- Built-in BrowserSync server -- For production builds: - - CSS compression - - JavaScript compression +**Frontend:** - Preact, React Redux, Redux, Spectre.css, three.js ### Build