Updating Docs

Author: Romulo Bordezani

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at bluebill1049@hotmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -0,0 +1,66 @@
+# Contributing to `Formoose`
+
+As the creators and maintainers of this project, we want to ensure that `formoose` lives and continues to grow and evolve. We would like to encourage everyone to help and support this library by contributing.
+
+## Code contributions
+
+Here is a quick guide to doing code contributions to the library.
+
+1. Fork and clone the repo to your local machine `git clone https://github.com/YOUR_GITHUB_USERNAME/formoose.git`
+
+2. Create a new branch from `main` with a meaningful name for a new feature or an issue you want to work on: `git checkout -b your-meaningful-branch-name`
+
+3. Install packages by running:
+
+   ```shellscript
+   yarn
+   ```
+
+4. If you've added a code that should be tested, ensure the test suite still passes.
+
+   ```shellscript
+   yarn test
+   ```
+
+5. Try to write some unit tests to cover as much of your code as possible.
+
+6. Ensure your code lints without errors.
+
+   ```shellscript
+   yarn lint
+   ```
+
+7. Type Script will compile to `dist` folder, use `yarn link`.
+
+Go to the [example repository](https://github.com/romulobordezani/formoose-examples) and run:
+
+```shell
+yarn link formoose
+```
+Run `yarn start` and the browser should open with some examples using your local Formoose's code. Now you can test and debug your changes.
+
+8. Ensure build passes.
+
+   ```shellscript
+   yarn build
+   ```
+
+9. Push your branch: `git push -u origin your-meaningful-branch-name`
+
+10. Submit a pull request to the upstream formoose repository.
+
+11. Choose a descriptive title and describe your changes briefly.
+
+## Coding style
+
+Please follow the coding style of the project. Formoose uses eslint and prettier. If possible, enable their respective plugins in your editor to get real-time feedback. The linting can be run manually with the following command: `yarn lint`.
+
+## License
+
+By contributing your code to the formoose GitHub repository, you agree to license your contribution under the MIT license.
+
+### Contributors
+
+Thank you to all the people who have already contributed to Formoose!
+
+<img src="https://opencollective.com/formoose/contributors.svg?width=950" />

README.md

@@ -7,29 +7,30 @@
 [![npm version](https://img.shields.io/npm/v/formoose.svg?style=flat)](https://www.npmjs.com/package/formoose)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://reactjs.org/docs/how-to-contribute.html#your-first-pull-request)
 <br /><br />
-#### Mongoose's schema based validation engine, made to integrate back and front-end validations easily and using same schemas
+#### Formoose is a runtime **validation engine**, based on Mongoose's 🐻 schemas.
 
-It **IS NOT** intended to do magic and generate automatically Html forms and fields, styles, and React components.
+Meant to integrate `React Controled Forms` with back-end APIs using [MongoDB](https://www.mongodb.com/).
 
-It **DOES** provide tools to validate the same Mongoose Schema using `React & Hooks` and `Node.js` integrating back and front end validations in the same source.
+It **IS NOT** intended to do magic and generate automatically HTML forms, fields, nor styles, or React components for you.
+
+It **DOES** provide an easy way to parse and validate the same **Mongoose** Schema using `React & Hooks`, integrating back and front-end validations in the same source of truth.
+
+**IMPORTANT Note**: 🐻 [Mongoose](https://mongoosejs.com/) lib isn't required at the front-side at all, you can use any schemas following [these guide lines](https://mongoosejs.com/docs/guide.html), and validate them using [Mongoose built in validators](https://mongoosejs.com/docs/validation.html#built-in-validators) at the back-end side. 
 
-**Important Note**: 🐻 Mongoose isn't required at all, but the supported schema follows [these guide lines](https://mongoosejs.com/docs/guide.html),
- what is different of [yup](https://github.com/jquense/yup) with its own .js Schemas, and also different of what [ajv](https://ajv.js.org/) does dealing with [json schemas](http://json-schema.org/).
 
 
  ### Provides:
-* Easy to use sync/async validations of Mongoose schemas, both in Client Side using `React Hooks` or on server side using `Node.js Promises`.
+* Fast sync/async validations for the whole schema.
 * Validation for single fields
-* Integration with React Hook `useState`, tools available to set up errors, clean, deal with changes etc.
+* Tools to set up errors on specific fields, to clean, deal with changes etc.
 * Friendly and consistent error messages with internationalization support using [react-i18next](https://www.npmjs.com/package/react-i18next). 
-* Configurable Error messages for each type checking
 * Real time validation in forms 
-* Custom validations using simple Java Script functions
+* Custom validations using simple Java Script functions, which allows you to validate whatever you want like Regexes, API based validations, custom logic etc.
 
 
 #### 🚀 Getting started:
 
-Example:
+Basic example:
 
 ```jsx
 import React, { useState } from 'react';
@@ -81,7 +82,7 @@ function FormooseFormExample() {
 export default FormooseFormExample;
 ```
 
-Examples available at [https://github.com/romulobordezani/formoose-example](https://github.com/romulobordezani/formoose-example)
+Examples available at [https://github.com/romulobordezani/formoose-example](https://github.com/romulobordezani/formoose-example) or at this [sand box](https://codesandbox.io/s/formoose-typescript-qchwm4?file=/src/components/FormooseForm/FormooseForm.tsx)
 
 #### Contributing:
 Fell free to fork and submit changes and improvements, also please let me know if you find any [issues](https://github.com/romulobordezani/formoose/issues).
@@ -96,12 +97,32 @@ yarn
 
 
 ```shell
-yarn start
+yarn dev
 ```
 
+Type Script will compile to `dist` folder, use `yarn link`.
+
+Go to the [example repository](https://github.com/romulobordezani/formoose-examples) and run:
 
 ```shell
-yarn run test
+yarn link formoose
 ```
+Run `yarn start` and the browser should open with some examples using your local Formoose's code. Now you can test and debug your changes.
+
+### Looking for something else? 
+
+So, you reached the end of these documentation and still thinks that Formoose is not for you?
+
+No problem! If you aren't interested in using `Mogoose schemas` to control your forms, or `i18n` to provide instant translations to your forms, or in the Type Script definitions to provide you a great Development Experience - in a really small package.
+
+Probably you are looking for something else like:
+
+* [zod](https://github.com/colinhacks/zod) 
+* [yup](https://github.com/jquense/yup)  
+* [ajv](https://ajv.js.org/) does dealing with [json schemas](http://json-schema.org/)
+* [joi](https://github.com/hapijs/joi)
+* [superstruct]https://github.com/ianstormtaylor/superstruct
+
+And to use it with [react-hook-form.com](https://react-hook-form.com/) or [formik](https://formik.org/) 
 
-Type Script will compile to `dist` folder, use `npm link` within the [example repository](https://github.com/romulobordezani/formoose-examples) to run and debug your changes.
+Hope it helps 🍀.