docs: improve README

CONTRIBUTING.md

@@ -0,0 +1,78 @@
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other
+method with the owners of this repository before making a change.
+
+Please note we have a code of conduct, please follow it in all your interactions with the project.
+
+## Pull Request Process
+
+1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
+2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed
+   ports, useful file locations and container parameters.
+3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would
+   represent. The versioning scheme we use is [SemVer](http://semver.org/).
+4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have
+   permission to do that, you may request the second reviewer to merge it for you.
+
+## 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, gender identity and expression, level of experience, 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 [nemausatpro@gmail.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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+
+[version]: http://contributor-covenant.org/version/1/4/

README.md

@@ -3,11 +3,51 @@
 ![License](https://img.shields.io/github/license/rjNemo/underscore?style=for-the-badge)
 ![Go version](https://img.shields.io/github/go-mod/go-version/rjNemo/underscore?style=for-the-badge)
 
-`underscore` is a `Go` library that provides useful functional programming helpers without extending any built-in
+![underscore](https://socialify.git.ci/rjNemo/underscore/image?description=1&descriptionEditable=A%20library%20providing%20useful%20functional%20programming%20helpers%20for%20Go%201.18&font=Raleway&language=1&logo=https%3A%2F%2Fgithub.com%2FrjNemo%2Funderscore%2Fblob%2Fmain%2Fdocs%2Funderscore.png%3Fraw%3Dtrue&name=1&pattern=Floating%20Cogs&theme=Light)
-objects.
+
+`underscore` is a `Go` library providing useful functional programming helpers without extending any built-in objects.
 
 It is mostly a port from the `underscore.js` library based on generics brought by `go1.18`.
 
+## Getting Started
+
+These instructions will get you a copy of the project up and running on your local machine for development and testing
+purposes.
+
+### Prerequisites
+
+You need at least `go1.18` for development. The project is shipped with a [Dockerfile](Dockerfile) based on `go1.18`. If
+you prefer local development, at the moment the easiest way to do it:
+
+```shell script
+go install golang.org/dl/go1.18beta1@latest
+go1.18beta1 download
+```
+
+### Installing
+
+First clone the repository
+
+```shell
+git clone https://github.com/rjNemo/underscore.git
+```
+
+Install dependencies
+
+```shell
+go mod download
+```
+
+And that's it.
+
+## Tests
+
+Building the docker image will run the tests automatically. Otherwise, you can simply run:
+
+```shell
+go test ./...
+```
+
 ## Functions
 
 `underscore` provides 100s of functions that support your favorite functional helpers
@@ -25,3 +65,32 @@ It is mostly a port from the `underscore.js` library based on generics brought b
 - `max`
 - `min`
 - `partition`
+
+## Built With
+
+- [Go](https://go.dev/) - Build fast, reliable, and efficient software at scale
+
+## Contributing
+
+Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull
+requests to us.
+
+## Versioning
+
+We use [SemVer](http://semver.org/) for versioning. For the versions available, see
+the [tags on this repository](https://github.com/rjNemo/underscore/tags).
+
+## Authors
+
+- **Ruidy** - _Initial work_ - [Ruidy](https://github.com/rjNemo)
+
+See also the list of [contributors](https://github.com/rjNemo/project/contributors) who participated in this project.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
+
+## Acknowledgments
+
+This project is largely inspired by [Underscore.js](https://underscorejs.org/#) library. Check out the original project
+if you don't already know it.