diff --git a/README.md b/README.md index 3854349f..13ba717f 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,28 @@ Compose the application from available screens, add backend integration and you The themes can be changed in the runtime, without any need of reloading the application. Download a live Demo published on both [App Store][link:app-store] and [Google Play][link:google-play] - or simply run it yourself by cloning a GitHub repo. + or simply run it yourself by cloning a GitHub repo (see the **[DEV_DOCS](./DEV_DOCS.md)** for more information) + + +----- + +
+Quick-start Instructions + +## Quickstart + +Follow the instructions below to fetch and configure the KittenTricks project and start a web interface from which you can launch iOS + Android device simulators or a browser-based experience + +```sh +git clone https://github.com/akveo/kittenTricks +cd kittenTricks +yarn # npm install +yarn run web # npm run start +``` + +
+ +------ ![Kitten Material](https://camo.githubusercontent.com/f0487d92194f3c685213539c53e9784113cd8a4b/68747470733a2f2f692e696d6775722e636f6d2f58384f344748622e706e67) diff --git a/package.json b/package.json index eca8351d..0b13549f 100644 --- a/package.json +++ b/package.json @@ -22,6 +22,7 @@ "ios": "react-native run-ios", "start": "npm run env -- prod && react-native start", "start:dev": "npm run env -- dev && react-native start --reset-cache", + "web": "expo start --web", "env": "node ./env/set-env.js", "build": "tsc -p ./tsconfig.json", "build:web": "expo build:web",