Skip to content

Commit

Permalink
Task: Update readme (#157)
Browse files Browse the repository at this point in the history
  • Loading branch information
tiagomapmarques authored Oct 3, 2019
1 parent 369b158 commit ee3ce1b
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ Quick start (docker):
| Branch | Base Branch | Objective | Completion | Status |
| ------ | ------ | ------ | ------ | ------ |
| [`develop`][link-develop] | - | vanilla javascript and/or typescript project | - | ![ci-develop][ci-develop] |
| [`minimal`][link-minimal] | `develop` | minimum for a sane frontend app | done | ![ci-minimal][ci-minimal] |
| `electron` | `develop` | vanilla electron project | TBD | - |
| [`web-components`][link-web-components] | `develop` | base for frontend app using web-components | unit-tests | ![ci-web-components][ci-web-components] |
| [`jquery`][link-jquery] | `develop` | base for frontend app using jquery | done | ![ci-jquery][ci-jquery] |
Expand Down Expand Up @@ -70,7 +71,7 @@ The following are the base commands for this application (`yarn`):
environments respectively
- `:watch` serves the app on `localhost:8000`, watches the files and rebuilds them upon change
- `serve [port=8000] [open=true] [spa=true]` serves the `public` folder
- `lint` performs `:code`, `:tests` and `:fix`
- `lint` performs `:code` and `:tests`
- `:code` lints the code, style and config according to `.eslintrc.code` and `.stylelintrc`
- `:tests` lints the tests according to `.eslintrc` (which is `.eslintrc.code` plus jest config)
- `:fix` tries to fix errors and warnings found by `lint:code` and `lint:tests`
Expand Down Expand Up @@ -106,6 +107,7 @@ other languages/libraries/frameworks.
| `weather-app-react-electron` | example of a react desktop application using this project | TBD | TBD |

[link-develop]: https://github.com/tiagomapmarques/js-boilerplate
[link-minimal]: https://github.com/tiagomapmarques/js-boilerplate/tree/minimal
[link-electron]: https://github.com/tiagomapmarques/js-boilerplate/tree/electron
[link-web-components]: https://github.com/tiagomapmarques/js-boilerplate/tree/web-components
[link-jquery]: https://github.com/tiagomapmarques/js-boilerplate/tree/jquery
Expand All @@ -117,6 +119,7 @@ other languages/libraries/frameworks.
[link-angular]: https://github.com/tiagomapmarques/js-boilerplate/tree/angular
[link-app-vue]: https://github.com/tiagomapmarques/js-boilerplate/tree/examples/weather-app-vue
[ci-develop]: https://circleci.com/gh/tiagomapmarques/js-boilerplate.svg?style=shield&circle-token=a1853ef566db72f165f70b008b5929d5978f2bcd
[ci-minimal]: https://circleci.com/gh/tiagomapmarques/js-boilerplate/tree/minimal.svg?style=shield&circle-token=a1853ef566db72f165f70b008b5929d5978f2bcd
[ci-electron]: https://circleci.com/gh/tiagomapmarques/js-boilerplate/tree/electron.svg?style=shield&circle-token=a1853ef566db72f165f70b008b5929d5978f2bcd
[ci-web-components]: https://circleci.com/gh/tiagomapmarques/js-boilerplate/tree/web-components.svg?style=shield&circle-token=a1853ef566db72f165f70b008b5929d5978f2bcd
[ci-jquery]: https://circleci.com/gh/tiagomapmarques/js-boilerplate/tree/jquery.svg?style=shield&circle-token=a1853ef566db72f165f70b008b5929d5978f2bcd
Expand Down
6 changes: 3 additions & 3 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -9507,9 +9507,9 @@ rc@^1.0.1, rc@^1.1.6, rc@^1.2.7:
strip-json-comments "~2.0.1"

react-is@^16.8.4:
version "16.10.1"
resolved "https://registry.yarnpkg.com/react-is/-/react-is-16.10.1.tgz#0612786bf19df406502d935494f0450b40b8294f"
integrity sha512-BXUMf9sIOPXXZWqr7+c5SeOKJykyVr2u0UDzEf4LNGc6taGkQe1A9DFD07umCIXz45RLr9oAAwZbAJ0Pkknfaw==
version "16.10.2"
resolved "https://registry.yarnpkg.com/react-is/-/react-is-16.10.2.tgz#984120fd4d16800e9a738208ab1fba422d23b5ab"
integrity sha512-INBT1QEgtcCCgvccr5/86CfD71fw9EPmDxgiJX4I2Ddr6ZsV6iFXsuby+qWJPtmNuMY0zByTsG4468P7nHuNWA==

read-all-stream@^3.0.0:
version "3.1.0"
Expand Down

0 comments on commit ee3ce1b

Please sign in to comment.