fix: finish readme

Author: wojtek-krysiak

README.md

@@ -24,4 +24,38 @@ What is missing:
 In order to start working on an AdminBro feature/plugin/adapter follow this steps:
 
 1. fork this repository
-2.
+2. Make sure it uses the latest versions of the packages
+2. rename package in package.json
+3. add env variables github settings:
+- SLACK_WEBHOOK
+- NPM_TOKEN
+4. in the root folder:
+- `yarn install`
+-  `yarn link` (registers package in `linked packages` repository)
+5. cd example-app
+- `yarn install`
+- `yarn add NAME_OF_YOUR_PACKAGE`
+- `yarn link NAME_OF_YOUR_PACKAGE`
+6. then in one terminal in the root folder run:
+- `yarn build --watch`
+7. in the second terminal in example app:
+- `yarn dev`
+
+You can read more about package linking in [yarn link documentation](https://classic.yarnpkg.com/en/docs/cli/link/)
+
+## Publishing to NPM
+
+package has semantic-release configured, but it don't upload build to NPM because of `private: true` set in package.json. In order to trigger automatic releases simply remove this line.
+
+## License
+
+AdminBro is Copyright © 2020 SoftwareBrothers.co. It is free software, and may be redistributed under the terms specified in the [LICENSE](LICENSE.md) file.
+
+## About SoftwareBrothers.co
+
+<img src="https://softwarebrothers.co/assets/images/software-brothers-logo-full.svg" width=240>
+
+We’re an open, friendly team that helps clients from all over the world to transform their businesses and create astonishing products.
+
+* We are available for [hire](https://softwarebrothers.co/contact).
+* If you want to work for us - checkout the [career page](https://softwarebrothers.co/career).

example-app/package.json

@@ -4,18 +4,22 @@
   "main": "index.js",
   "license": "MIT",
   "scripts": {
-    "start": "ts-node src/index.ts",
+    "build": "tsc",
+    "start": "yarn build && node build/index.js",
+    "start:dev": "concurrently \"yarn build --watch\" \"nodemon --ext '.js' --watch ../build --watch ./build --ignore 'cypress/**/*.js' node build/src/index.js\"",
     "cypress:open": "cypress open",
     "cypress:run": "cypress run"
   },
   "devDependencies": {
     "@types/express": "^4.17.7",
-    "ts-node": "^8.10.2",
+    "concurrently": "^5.2.0",
     "cypress": "^4.11.0",
+    "nodemon": "^2.0.4",
+    "ts-node": "^8.10.2",
     "typescript": "^3.9.7"
   },
   "dependencies": {
-    "@admin-bro/core": "^3.0.0-beta.2",
+    "@admin-bro/core": "^3.0.0-beta.4",
     "@admin-bro/express": "^3.0.0-beta.1",
     "express": "^4.17.1",
     "express-formidable": "^1.2.0",