Move docs to Wiki and modify README - Githubissues

Farfetch / rules-framework

A generic framework that allows defining and evaluating rules for complex business scenarios.

MIT License

41 stars 8 forks source link

Move docs to Wiki and modify README #139

Closed jdromeiro closed 1 year ago

jdromeiro commented 1 year ago

Description

Moves the documentation to the wiki section in GitHub.
Repurposes the README to contain a brief explanation of what Rules.Framework offers to users and how to use it.
Adds code to the WebUI sample project to create the example shown in the new README

Also mention any issues to be closed with this pull request: Closes #134 .

Preview:

Change checklist

[ ] Code follows the code rules guidelines of this project
[ ] Commit messages follow the commit rules of this project
[ ] I have self-reviewed my changes before submitting this pull request
[ ] I have covered new/changed code with new tests and/or adjusted existent ones
[ ] I have made changes necessary to update the documentation accordingly

Please also check the I want to contribute guidelines and make sure you have done accordingly.

Disclaimer

By sending us your contributions, you are agreeing that your contribution is made subject to the terms of our Contributor Ownership Statement