diff --git a/README.md b/README.md index 8b8c8ba..ae0dd26 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ # RiotJS App Starter > A Rapid Application Starter kit for RiotJS minimalists -Rapidly prototype your next single-page application, with a `zero-build` out-of-the-box web-component solution using [RiotJS](https://riot.js.org/) for the fastest way to iterate over UI for development -- **bar-none**. +Rapidly prototype your next single-page application, with a `zero-build` out-of-the-box web-component solution using [RiotJS](https://riot.js.org/) for the fastest way to iterate over UI for development -- **bar-none**. -No crazy syntax, just HTML, CSS and JavaScript. +No crazy syntax, just HTML, CSS and JavaScript. -No isolated eco-system, work with any library, any tool, any way you want! +No isolated eco-system, work with any library, any tool, any way you want! [RiotJS](https://riot.js.org/) is tiny; tiny foot print, tiny API, and this leads it to be extremely fast to learn -- closest to web standards as you can get. @@ -24,7 +24,7 @@ What are you waiting for -- **GO FORTH AND BUILD YOUR APP, RAPIDLY!** **Requirements** -- [NodeJS](https://nodejs.org/) +- [NodeJS](https://nodejs.org/) > Installs `vendor/` dependencies and `npm build` to get your project into production @@ -88,14 +88,14 @@ These files are usually saved as `my-component.tag`, but to get proper syntax hi Of course we want our component to do more, so... -...*for now*, go check out the [RiotJS GuideI](https://riot.js.org/guide/) +...*for now*, go check out the [RiotJS Guide](https://riot.js.org/guide/) ## Build for Production When you are ready to move to production you can run `npm build`. This will create a `dist` folder with all your optimized assets, web-components, vendor dependencies and remove the riot `runtime-compiler` to shave off another 100kb -Check out the [gulpfile]('gulpfile.js') for all the build options if you do not want to build everything. Every task is commented, and split-up so you can grep it easily. +Check out the [gulpfile]('./gulpfile.js') for all the build options if you do not want to build everything. Every task is commented, and split-up so you can grep it easily. ## Testing @@ -111,7 +111,7 @@ Check out the [gulpfile]('gulpfile.js') for all the build options if you do not ## TODO - Include a testing framework [Jasmine](https://jasmine.github.io/), [test.it](https://github.com/n2geoff/testit), or? -- Is good AJAX support the missing ingredient? or is`fetch` good enough? +- Is good AJAX support the missing ingredient? or is`fetch` good enough? - add routing example ## Support