Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add readme #18

Merged
merged 1 commit into from
Oct 1, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions CONTRIBUTORS.md
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 -->
56 changes: 15 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,58 +1,32 @@
# eslint-config-twilio
# const TwilioStyle = () => {

[![Status](https://travis-ci.com/twilio-labs/eslint-config-twilio.svg?branch=master)](https://travis-ci.com/twilio-labs/eslint-config-twilio)
[![Version](https://img.shields.io/npm/v/eslint-config-twilio.svg?style=square)](https://www.npmjs.com/package/eslint-config-twilio)
[![Downloads](https://img.shields.io/npm/dt/eslint-config-twilio.svg?style=square)](https://www.npmjs.com/package/eslint-config-twilio)
[![License](https://img.shields.io/npm/l/eslint-config-twilio.svg?style=square)](../../LICENSE)
[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors)
[![License](https://img.shields.io/npm/l/eslint-config-twilio.svg?style=square)](./LICENSE)
[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](./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).

# }
41 changes: 41 additions & 0 deletions packages/eslint-config-twilio-react/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# eslint-config-twilio-react

[![Status](https://travis-ci.com/twilio-labs/eslint-config-twilio-react.svg?branch=master)](https://travis-ci.com/twilio-labs/eslint-config-twilio-react)
[![Version](https://img.shields.io/npm/v/eslint-config-twilio-react.svg?style=square)](https://www.npmjs.com/package/eslint-config-twilio-react)
[![Downloads](https://img.shields.io/npm/dt/eslint-config-twilio-react.svg?style=square)](https://www.npmjs.com/package/eslint-config-twilio-react)
[![License](https://img.shields.io/npm/l/eslint-config-twilio.svg-react?style=square)](../../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"
]
}
```
41 changes: 41 additions & 0 deletions packages/eslint-config-twilio/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# eslint-config-twilio

[![Status](https://travis-ci.com/twilio-labs/eslint-config-twilio.svg?branch=master)](https://travis-ci.com/twilio-labs/eslint-config-twilio)
[![Version](https://img.shields.io/npm/v/eslint-config-twilio.svg?style=square)](https://www.npmjs.com/package/eslint-config-twilio)
[![Downloads](https://img.shields.io/npm/dt/eslint-config-twilio.svg?style=square)](https://www.npmjs.com/package/eslint-config-twilio)
[![License](https://img.shields.io/npm/l/eslint-config-twilio.svg?style=square)](../../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"
]
}
```