Merge pull request #30 from nobrainr/Fix/docs

fix: update ReadMe to include @latest on npx command
nobrainr · Sep 23, 2018 · 5a18797 · 5a18797
2 parents 58c7935 + ff14b80
commit 5a18797
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -31,7 +31,7 @@ They are preconfigured so that you can focus on the code, but as a starter kit y
 
 ```sh
 # Use NPX or npm install -g create-ts-lib to install it as a global package
-npx create-ts-lib my-typescript-lib
+npx create-ts-lib@latest my-typescript-lib
 cd my-typescript-lib && npm start
 ```
 
@@ -55,7 +55,6 @@ my-typescript-lib
 ├── karma.conf.js
 ├── tsconfig.json
 ├── tslint.json
-├── typings.json
 └── webpack.config.js
 ```
 

diff --git a/packages/cli/README.md b/packages/cli/README.md
@@ -1,4 +1,6 @@
-# create-ts-lib [![CircleCI](https://img.shields.io/circleci/project/github/nobrainr/typescript-webpack-starter.svg)](https://circleci.com/gh/nobrainr/workflows/typescript-webpack-starter/tree/master) [![Npm Package](https://img.shields.io/npm/v/create-ts-lib.svg)](https://www.npmjs.com/package/create-ts-lib)
+# create-ts-lib [![Backers on Open Collective](https://opencollective.com/typescript-webpack-starter/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/typescript-webpack-starter/sponsors/badge.svg)](#sponsors) [![CircleCI](https://img.shields.io/circleci/project/github/nobrainr/typescript-webpack-starter.svg)](https://circleci.com/gh/nobrainr/workflows/typescript-webpack-starter/tree/master) [![Npm Package](https://img.shields.io/npm/v/create-ts-lib.svg)](https://www.npmjs.com/package/create-ts-lib)
+
+![](https://s3.us-east-2.amazonaws.com/typescript-webpack-starter/create-ts-lib.gif)
 
 ## Quick Start
 
@@ -29,7 +31,7 @@ They are preconfigured so that you can focus on the code, but as a starter kit y
 
 ```sh
 # Use NPX or npm install -g create-ts-lib to install it as a global package
-npx create-ts-lib my-typescript-lib
+npx create-ts-lib@latest my-typescript-lib
 cd my-typescript-lib && npm start
 ```
 
@@ -53,7 +55,6 @@ my-typescript-lib
 ├── karma.conf.js
 ├── tsconfig.json
 ├── tslint.json
-├── typings.json
 └── webpack.config.js
 ```
 
@@ -84,3 +85,29 @@ dist
 ## Development
 
 We'd love to have your helping hand on `create-ts-lib`! See [CONTRIBUTING.md](CONTRIBUTING.md) for more information on what we're looking for and how to get started.
+
+## Contributors
+
+This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
+<a href="graphs/contributors"><img src="https://opencollective.com/typescript-webpack-starter/contributors.svg?width=890&button=false" /></a>
+
+## Backers
+
+Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/typescript-webpack-starter#backer)]
+
+<a href="https://opencollective.com/typescript-webpack-starter#backers" target="_blank"><img src="https://opencollective.com/typescript-webpack-starter/backers.svg?width=890"></a>
+
+## Sponsors
+
+Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/typescript-webpack-starter#sponsor)]
+
+<a href="https://opencollective.com/typescript-webpack-starter/sponsor/0/website" target="_blank"><img src="https://opencollective.com/typescript-webpack-starter/sponsor/0/avatar.svg"></a>
+<a href="https://opencollective.com/typescript-webpack-starter/sponsor/1/website" target="_blank"><img src="https://opencollective.com/typescript-webpack-starter/sponsor/1/avatar.svg"></a>
+<a href="https://opencollective.com/typescript-webpack-starter/sponsor/2/website" target="_blank"><img src="https://opencollective.com/typescript-webpack-starter/sponsor/2/avatar.svg"></a>
+<a href="https://opencollective.com/typescript-webpack-starter/sponsor/3/website" target="_blank"><img src="https://opencollective.com/typescript-webpack-starter/sponsor/3/avatar.svg"></a>
+<a href="https://opencollective.com/typescript-webpack-starter/sponsor/4/website" target="_blank"><img src="https://opencollective.com/typescript-webpack-starter/sponsor/4/avatar.svg"></a>
+<a href="https://opencollective.com/typescript-webpack-starter/sponsor/5/website" target="_blank"><img src="https://opencollective.com/typescript-webpack-starter/sponsor/5/avatar.svg"></a>
+<a href="https://opencollective.com/typescript-webpack-starter/sponsor/6/website" target="_blank"><img src="https://opencollective.com/typescript-webpack-starter/sponsor/6/avatar.svg"></a>
+<a href="https://opencollective.com/typescript-webpack-starter/sponsor/7/website" target="_blank"><img src="https://opencollective.com/typescript-webpack-starter/sponsor/7/avatar.svg"></a>
+<a href="https://opencollective.com/typescript-webpack-starter/sponsor/8/website" target="_blank"><img src="https://opencollective.com/typescript-webpack-starter/sponsor/8/avatar.svg"></a>
+<a href="https://opencollective.com/typescript-webpack-starter/sponsor/9/website" target="_blank"><img src="https://opencollective.com/typescript-webpack-starter/sponsor/9/avatar.svg"></a>