From a620971276a758d2e1a964a3ea45f48b1236bde7 Mon Sep 17 00:00:00 2001 From: Michael Schramm Date: Mon, 1 Jun 2020 00:53:28 +0200 Subject: [PATCH] update readme --- README.md | 37 +++++++++---------------------------- doc/development.md | 8 ++++++++ package.json | 2 +- 3 files changed, 18 insertions(+), 29 deletions(-) create mode 100644 doc/development.md diff --git a/README.md b/README.md index 253c04f..c310d2b 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,11 @@ # OhMyForm API +[![Financial Contributors on Open Collective](https://opencollective.com/ohmyform-sustainability/all/badge.svg?label=financial+contributors)](https://opencollective.com/ohmyform-sustainability) +![Project Status](https://img.shields.io/badge/status-0.9.0-green.svg) + +[![Discord](https://img.shields.io/discord/595773457862492190.svg?label=Discord%20Chat)](https://discord.gg/MJqAuAZ) +> An *open source alternative to TypeForm* that can create stunning mobile-ready forms, surveys and questionnaires. + ## Description [OhMyForm](https://github.com/ohmyforn) api backend @@ -17,36 +23,11 @@ $ npm install ```bash # development -$ npm run start +$ yarn run start # watch mode -$ npm run start:dev +$ yarn run start:dev # production mode -$ npm run start:prod +$ yarn run start:prod ``` - -## Test - -```bash -# unit tests -$ npm run test - -# e2e tests -$ npm run test:e2e - -# test coverage -$ npm run test:cov -``` - -## Support - -TODO - -## Stay in touch - -- Website - [https://ohmyform.com](https://ohmyform.com/) - -## License - -TODO diff --git a/doc/development.md b/doc/development.md new file mode 100644 index 0000000..781fd1c --- /dev/null +++ b/doc/development.md @@ -0,0 +1,8 @@ +# Development + +tip's and tricks to get you started + +## First Run + +install yarn on your system if not already present and then install all dependencies +by running `yarn install` diff --git a/package.json b/package.json index 700bd87..e2bdb97 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "ohmyform-api", - "version": "0.3.0", + "version": "0.9.0", "description": "", "author": "", "license": "MIT",