Skip to content

Commit

Permalink
feat: add readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
amorino committed Feb 12, 2021
1 parent 5b726c9 commit 23a59d8
Show file tree
Hide file tree
Showing 4 changed files with 78 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# @amorino/eslint-config

These are personal configurations for projects using:
- [Next.JS](https://github.com/amorino/eslint-config/tree/main/packages/eslint-config-next)
- [React Native](https://github.com/amorino/eslint-config/tree/main/packages/eslint-config-native)

They use the base configuration:
- [TypeScript](https://github.com/amorino/eslint-config/tree/main/packages/eslint-config-base)
23 changes: 23 additions & 0 deletions packages/eslint-config-base/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# TypeScript
[![Version][version-badge]][package]

## Installation

```
yarn add --dev eslint prettier @amorino/eslint-config-base
```

*Note: I'm using `yarn` to install deps. Feel free to change commands to use `npm` 3+ and `npx` if you like*

## Usage

Add to your eslint config (`.eslintrc`, or `eslintConfig` field in `package.json`):

```json
{
"extends": "@amorino/eslint-config-base"
}
```

[version-badge]: https://img.shields.io/npm/v/@amorino/eslint-config-base.svg?style=flat-square
[package]: https://www.npmjs.com/package/@amorino/eslint-config-base
24 changes: 24 additions & 0 deletions packages/eslint-config-native/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# React Native
[![Version][version-badge]][package]

## Installation

```
yarn add --dev eslint prettier @amorino/eslint-config-native
```

*Note: I'm using `yarn` to install deps. Feel free to change commands to use `npm` 3+ and `npx` if you like*


## Usage

Add to your eslint config (`.eslintrc`, or `eslintConfig` field in `package.json`):

```json
{
"extends": "@amorino/eslint-config-native"
}
```

[version-badge]: https://img.shields.io/npm/v/@amorino/eslint-config-base.svg?style=flat-square
[package]: https://www.npmjs.com/package/@amorino/eslint-config-base
23 changes: 23 additions & 0 deletions packages/eslint-config-next/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Next.JS
[![Version][version-badge]][package]

## Installation

```
yarn add --dev eslint prettier @amorino/eslint-config-next
```

*Note: I'm using `yarn` to install deps. Feel free to change commands to use `npm` 3+ and `npx` if you like*


## Usage

Add to your eslint config (`.eslintrc`, or `eslintConfig` field in `package.json`):

```json
{
"extends": "@amorino/eslint-config-next"
}
```
[version-badge]: https://img.shields.io/npm/v/@amorino/eslint-config-base.svg?style=flat-square
[package]: https://www.npmjs.com/package/@amorino/eslint-config-base

0 comments on commit 23a59d8

Please sign in to comment.