diff --git a/README.md b/README.md index 4926d41..1c34038 100644 --- a/README.md +++ b/README.md @@ -11,21 +11,24 @@ You must have **Node.js** Installed on your Machine

Don't have node intalled? You can download it from official node.js website [official Node.js website](https://pages.github.com/). +
app uses typescript (for type-safety) and webpack (for bundling) ## Getting Started -1. Open terminal and type -1. ``` - npm install - npx tsc - ``` -1. Copy the contents of `dist` directory into your project folder +1. Open up the terminal and type +``` +npm install +``` +2. Then to build the project: +``` +npm run build +``` +1. Copy the contents of `build` directory into your project folder 1. Link all files in the `js` folder to your html file (before your main javascript file). -Now you can use the `addCanvas` function in your app - ## Configurations -your fireflies canvas has a default configuration that can be edited (before tsc) in `src/config.ts` +your fireflies canvas has configuration that can be edited in `src/config` directory +then use `npm start` to run the project in development mode. See the 'example' folder to learn about how the application works