-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #18 from twilio-labs/readme
add readme
- Loading branch information
Showing
4 changed files
with
112 additions
and
41 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| # Contributors | ||
|
|
||
| Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): | ||
|
|
||
| <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> | ||
| <!-- prettier-ignore --> | ||
| <table> | ||
| <tr> | ||
| <td align="center"><a href="https://github.com/ahcai"><img src="https://avatars3.githubusercontent.com/u/4912483?v=4" width="100px;" alt="Alice Cai"/><br /><sub><b>Alice Cai</b></sub></a><br /><a href="https://github.com/twilio-labs/eslint-config-twilio/commits?author=ahcai" title="Code">💻</a> <a href="#ideas-ahcai" title="Ideas, Planning, & Feedback">🤔</a></td> | ||
| <td align="center"><a href="https://github.com/ktalebian"><img src="https://avatars2.githubusercontent.com/u/2308915?v=4" width="100px;" alt="Kousha Talebian"/><br /><sub><b>Kousha Talebian</b></sub></a><br /><a href="#ideas-ktalebian" title="Ideas, Planning, & Feedback">🤔</a> <a href="#review-ktalebian" title="Reviewed Pull Requests">👀</a></td> | ||
| <td align="center"><a href="https://github.com/theryankennedy"><img src="https://avatars3.githubusercontent.com/u/218683?v=4" width="100px;" alt="Ryan Kennedy"/><br /><sub><b>Ryan Kennedy</b></sub></a><br /><a href="#ideas-theryankennedy" title="Ideas, Planning, & Feedback">🤔</a></td> | ||
| </tr> | ||
| </table> | ||
|
|
||
| <!-- ALL-CONTRIBUTORS-LIST:END --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,58 +1,32 @@ | ||
| # eslint-config-twilio | ||
| # const TwilioStyle = () => { | ||
|
|
||
| [](https://travis-ci.com/twilio-labs/eslint-config-twilio) | ||
| [](https://www.npmjs.com/package/eslint-config-twilio) | ||
| [](https://www.npmjs.com/package/eslint-config-twilio) | ||
| [](../../LICENSE) | ||
| [](#contributors) | ||
| [](./LICENSE) | ||
| [](./CONTRIBUTORS.md) | ||
|
|
||
| This package provides Twilio's .eslintrc as an extensible shared config. | ||
| This monorepo contains styling guide for: | ||
|
|
||
| ## Installation | ||
|
|
||
| ```bash | ||
| $ npm install eslint-config-twilio --save-dev | ||
| ``` | ||
| * [JavaScript](./packages/eslint-config-twilio) | ||
| * [React](./packages/eslint-config-twilio-react) | ||
|
|
||
| ## Usage | ||
|
|
||
| Add an ESLint config to your `package.json`: | ||
|
|
||
| ```json | ||
| { | ||
| "name": "my-project", | ||
| "eslintConfig": { | ||
| "extends": "eslint-config-twilio" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| Or to `.eslintrc`: | ||
| Please refer to the guides above for usage of each guide you want. | ||
|
|
||
| ```json | ||
| { | ||
| "extends": "eslint-config-twilio" | ||
| } | ||
| ``` | ||
| ## Contributing | ||
|
|
||
| ## Contributors ✨ | ||
| Check out [CONTRIBUTING](CONTRIBUTING.md) for more information on how to contribute to this project. | ||
|
|
||
| Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): | ||
| ## Contributors | ||
|
|
||
| <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> | ||
| <!-- prettier-ignore --> | ||
| <table> | ||
| <tr> | ||
| <td align="center"><a href="https://github.com/ahcai"><img src="https://avatars3.githubusercontent.com/u/4912483?v=4" width="100px;" alt="Alice Cai"/><br /><sub><b>Alice Cai</b></sub></a><br /><a href="https://github.com/twilio-labs/eslint-config-twilio/commits?author=ahcai" title="Code">💻</a> <a href="#ideas-ahcai" title="Ideas, Planning, & Feedback">🤔</a></td> | ||
| <td align="center"><a href="https://github.com/ktalebian"><img src="https://avatars2.githubusercontent.com/u/2308915?v=4" width="100px;" alt="Kousha Talebian"/><br /><sub><b>Kousha Talebian</b></sub></a><br /><a href="#ideas-ktalebian" title="Ideas, Planning, & Feedback">🤔</a> <a href="#review-ktalebian" title="Reviewed Pull Requests">👀</a></td> | ||
| <td align="center"><a href="https://github.com/theryankennedy"><img src="https://avatars3.githubusercontent.com/u/218683?v=4" width="100px;" alt="Ryan Kennedy"/><br /><sub><b>Ryan Kennedy</b></sub></a><br /><a href="#ideas-theryankennedy" title="Ideas, Planning, & Feedback">🤔</a></td> | ||
| </tr> | ||
| </table> | ||
| Thanks goes to the wonderful people listed in [CONTRIBUTORS.md](CONTRIBUTORS.md). | ||
|
|
||
| <!-- ALL-CONTRIBUTORS-LIST:END --> | ||
|
|
||
| This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! | ||
| This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome! | ||
|
|
||
| ## License | ||
|
|
||
| MIT | ||
| Twilio Style is licensed under [MIT](LICENSE). | ||
|
|
||
| # } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| # eslint-config-twilio-react | ||
|
|
||
| [](https://travis-ci.com/twilio-labs/eslint-config-twilio-react) | ||
| [](https://www.npmjs.com/package/eslint-config-twilio-react) | ||
| [](https://www.npmjs.com/package/eslint-config-twilio-react) | ||
| [](../../LICENSE) | ||
|
|
||
| Twilio's approach to React styling. | ||
|
|
||
| ## Installation | ||
|
|
||
| ```bash | ||
| $ npm install eslint eslint-plugin-react eslint-config-twilio-react --save-dev | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| Add the ESLint config to either your `package.json` or your `.eslintrc`: | ||
|
|
||
| ### package.json | ||
|
|
||
| ```json | ||
| { | ||
| "name": "my-project", | ||
| "eslintConfig": { | ||
| "extends": [ | ||
| "eslint-config-twilio-react" | ||
| ] | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### .eslintrc | ||
|
|
||
| ```json | ||
| { | ||
| "extends": [ | ||
| "eslint-config-twilio-react" | ||
| ] | ||
| } | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| # eslint-config-twilio | ||
|
|
||
| [](https://travis-ci.com/twilio-labs/eslint-config-twilio) | ||
| [](https://www.npmjs.com/package/eslint-config-twilio) | ||
| [](https://www.npmjs.com/package/eslint-config-twilio) | ||
| [](../../LICENSE) | ||
|
|
||
| Twilio's approach to JavaScript styling. | ||
|
|
||
| ## Installation | ||
|
|
||
| ```bash | ||
| $ npm install eslint eslint-config-twilio --save-dev | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| Add the ESLint config to either your `package.json` or your `.eslintrc`: | ||
|
|
||
| ### package.json | ||
|
|
||
| ```json | ||
| { | ||
| "name": "my-project", | ||
| "eslintConfig": { | ||
| "extends": [ | ||
| "eslint-config-twilio" | ||
| ] | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### .eslintrc | ||
|
|
||
| ```json | ||
| { | ||
| "extends": [ | ||
| "eslint-config-twilio" | ||
| ] | ||
| } | ||
| ``` |