aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorEugene Sokolov <eug-vs@keemail.me>2020-02-06 20:57:07 +0300
committerGitHub <noreply@github.com>2020-02-06 20:57:07 +0300
commit2e79b97a5862746552f5449085b3924e30d882d7 (patch)
tree918aa5ace84db1ce6bc7d4c7b24ab7720e7cd90c /README.md
parent4eb7eeffa0251d4b5d465244f8d06561d7403385 (diff)
downloadreact-benzin-2e79b97a5862746552f5449085b3924e30d882d7.tar.gz
docs: add building and deploying info
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
index f6e1f8f..f26984e 100644
--- a/README.md
+++ b/README.md
@@ -42,3 +42,12 @@ $ npm test
```
**NOTE**: this command assures that `ESlint` does not throw any warnings and exits with a *non-zero status code* otherwise. That means `CircleCI` tests would fail *even if a single warning is present*. Therefore, you should always locally test your changes before publishing them.
+## Building
+We've decided to use `Typescript compiler` to transpile our code, since we think `Babel` is a bit of an overkill here.
+```bash
+$ npm run build
+```
+This command will generate `dist/` folder ready for distribution, which you of course can explore. Note that `tsc` creates type definitions (`.d.ts`) for every corresponding `.js` file. It's very useful because consumers also get access to them.
+
+## Deploying
+Deploying to `npm` is fully automated through **CircleCI**: simply tag a commit as a Release and it will do the job.