feat: adds readme

.eslintrc.cjs

@@ -45,7 +45,6 @@ module.exports = {
       },
     },
     {
-      // 3) Now we enable eslint-plugin-testing-library rules or preset only for matching testing files!
       files: ["cypress/**"],
       rules: {
         "@typescript-eslint/no-unsafe-call": "off",

README.md

@@ -1,30 +1,64 @@
-# React + TypeScript + Vite
+<h1 align="center">Welcome to msr-register-form 👋</h1>
+<p>
+  <img src="https://img.shields.io/badge/node-%3E%3D20.12.2-blue.svg" />
+  <img src="https://img.shields.io/badge/pnpm-%3E%3D9.2.0-blue.svg" />
+  <a href="https://github.com/mapadoacolhimento/msr-register-form#readme" target="_blank">
+    <img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
+  </a>
+  <a href="https://github.com/mapadoacolhimento/msr-register-form/graphs/commit-activity" target="_blank">
+    <img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" />
+  </a>
+  <a href="https://github.com/mapadoacolhimento/msr-register-form/blob/master/LICENSE" target="_blank">
+    <img alt="License: CC--BY--SA--4.0" src="https://img.shields.io/github/license/mapadoacolhimento/msr-register-form" />
+  </a>
+</p>
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+> Formulário de cadastro das acolhidas do Mapa do Acolhimento.
 
-Currently, two official plugins are available:
+### 🏠 [Homepage](https://github.com/mapadoacolhimento/msr-register-form/#readme)
 
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+### ✨ [Demo](https://novo.queroseracolhida.mapadoacolhimento.org/)
 
-## Expanding the ESLint configuration
+## Prerequisites
 
-If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
+- node >=20.12.2
+- pnpm >=9.2.0
 
-- Configure the top-level `parserOptions` property like this:
+## Install
 
-```js
-export default {
-  // other rules...
-  parserOptions: {
-    ecmaVersion: "latest",
-    sourceType: "module",
-    project: ["./tsconfig.json", "./tsconfig.node.json"],
-    tsconfigRootDir: __dirname,
-  },
-};
+```sh
+pnpm install
 ```
 
-- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`
-- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
-- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list
+## Usage
+
+```sh
+pnpm run dev
+```
+
+## Run tests
+
+```sh
+pnpm run test
+```
+
+## Author
+
+👤 **Desenvolvedoras Mapa**
+
+- Website: https://mapadoacolhimento.org/
+- Github: [@mapadoacolhimento](https://github.com/mapadoacolhimento)
+- LinkedIn: [@https:\/\/www.linkedin.com\/company\/mapadoacolhimento\/](https://linkedin.com/in/https://www.linkedin.com/company/mapadoacolhimento/)
+
+## Show your support
+
+Give a ⭐️ if this project helped you!
+
+## 📝 License
+
+Copyright © 2024 [Desenvolvedoras Mapa](https://github.com/mapadoacolhimento).<br />
+This project is [CC--BY--SA--4.0](https://github.com/mapadoacolhimento/msr-register-form/blob/master/LICENSE) licensed.
+
+---
+
+_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_

package.json

@@ -1,7 +1,6 @@
 {
   "name": "msr-register-form",
   "private": false,
-  "version": "0.0.0",
   "type": "module",
   "scripts": {
     "dev": "vite",
@@ -56,12 +55,19 @@
     "type": "git",
     "url": "https://github.com/mapadoacolhimento/msr-register-form.git"
   },
+  "homepage": "https://github.com/mapadoacolhimento/msr-register-form/#readme",
   "license": "CC-BY-SA-4.0",
   "lint-staged": {
     "*.json": "prettier --write --ignore-unknown",
     "*.{js,jsx,ts,tsx,md,html,css,cjs}": "prettier --write --ignore-unknown",
     "*.{js,jsx,ts,tsx}": [
       "eslint --fix"
     ]
-  }
+  },
+  "author": {
+    "name": "Desenvolvedoras Mapa",
+    "email": "[email protected]",
+    "url": "https://mapadoacolhimento.org"
+  },
+  "description": "Formulário de cadastro das acolhidas do Mapa do Acolhimento."
 }