Docs: update READMEs for eslint-plugin (#36)

* docs: update eslint plugin README

* docs: update monorepo README

Author: P0labrD

README.md

@@ -1,18 +1,19 @@
-# react-native-project-config
+# react-native-project-config by BAM
 
-Monorepo with packages for setting up ESLint, Typescript, Prettier and Jest.
+Monorepo with packages for setting up ESLint and Typescript for any new React Native project.
 
 ## Presentation
 
 The goal of the project is too have a set of configuration files that can be easily imported into a new project, which would reduce the burden of starting new projects.
 
-This repo uses [lerna](https://lerna.js.org/) to maintain, version and publish various packages for configuring ESLint, Typescript, Prettier and Jest.
+This repo uses [lerna](https://lerna.js.org/) to maintain, version and publish various packages for configuring ESLint and Typescript.
 
 There is also an example app under `packages/example-app` whose goal is to demonstrate how to import and use the configuration packages.
 
 ## Using the configurations
 
 - [Using ESLint plugin](./packages/eslint-plugin/README.md)
+- [Using Typescript config](./packages/typescript-config/README.md)
 
 ## Installing the project
 

packages/eslint-plugin/README.md

@@ -1,6 +1,6 @@
-# ESLint plugin for BAM
+# ESLint plugin by BAM
 
-This project is an ESLint plugin that gathers all the rules, plugins and parsers that should be used in any new BAM project.
+This project is an ESLint plugin that gathers all the rules, plugins and parsers that should be used in any new react-native BAM project.
 
 ## Quick Setup
 
@@ -19,7 +19,7 @@ Then update your `.eslintrc` config file:
   "extends": "plugin:@bam.tech/recommended",
   "overrides": [
     {
-      "files": ["*.test.tsx"],
+      "files": ["*.test.tsx", "*.test.ts"],
       "extends": "plugin:@bam.tech/tests"
     }
   ]
@@ -30,11 +30,11 @@ Then update your `.eslintrc` config file:
 
 This plugin exports multiple configurations that can be used in your `.eslintrc` config file:
 
-| Name                    | Description                                                                                                                                                  |
-| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `@bam.tech/recommended` | The recommended config for all projects                                                                                                                      |
-| `@bam.tech/tests`       | The recommended config for test files. By default this applies to every file: put it in an `overrides` to filter on your test files.                         |
-| `@bam.tech/a11y`        | [beta] Eslint config to check for accessibility. Still in beta to not break existing projects, but will be merged into the recommended config in the future. |
+| Name                                                    | Description                                                                                                                                                  |
+| ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| [`@bam.tech/recommended`](./lib/configs/recommended.js) | The recommended config for all projects                                                                                                                      |
+| [`@bam.tech/tests`](./lib/configs/tests.js)             | The recommended config for test files. By default this applies to every file: put it in an `overrides` to filter on your test files.                         |
+| [`@bam.tech/a11y` ](./lib/configs/a11y.js)              | [beta] Eslint config to check for accessibility. Still in beta to not break existing projects, but will be merged into the recommended config in the future. |
 
 These configs need some peer dependencies. You can list them with: