Skip to content

Commit

Permalink
docs: ✏️ replace structure with content
Browse files Browse the repository at this point in the history
  • Loading branch information
kaisermann committed Jan 30, 2020
1 parent 268cfa3 commit 986a762
Showing 1 changed file with 13 additions and 12 deletions.
25 changes: 13 additions & 12 deletions README.md
Expand Up @@ -2,18 +2,19 @@

Main repository for VTEX's javascript standards. Issues should be used to start discussions about standards and patterns. PRs are welcome after being rightfully discussed.

## Project Structure

```tree
docs/ # standards documentation
└── Browser\ Support.md # VTEX browser support documentation
packages/ # standards related packages
├── eslint-config-vtex # base eslint rule preset
├── eslint-config-vtex-react # eslint rule preset for react projects
├── eslint-plugin-vtex # eslint plugin with VTEX custom rules
├── prettier-config # prettier preset of all front-end projects
└── tsconfig # base tsconfig for all typescript projects
```
## Content

##### `docs/`

- [Browser Support](/docs/Browser%20Support.md) - VTEX browser support documentation

##### `packages/`

- [eslint-config-vtex](/packages/eslint-config-vtex) - base eslint rule preset
- [eslint-config-vtex-react](/packages/eslint-config-vtex-react) - eslint rule preset for react projects
- [eslint-plugin-vtex](/packages/eslint-plugin-vtex) - eslint plugin with VTEX custom rules
- [prettier-config](/packages/prettier-config) - prettier preset of all front-end projects
- [tsconfig](/packages/tsconfig) - base tsconfig for all typescript projects

## Contributing

Expand Down

0 comments on commit 986a762

Please sign in to comment.