Improve README

Author: alies-dev

CONTRIBUTING.md

@@ -1 +1,80 @@
+# 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 reflect important changes (new options, changed API, etc).
+3. Regenerate dist assets using production env: `npm run prod`.
+
+### Compiling Assets
+
+```bash
+# Compile and minify your assets:
+npm run prod
+
+# Compile your assets for local development:
+npm run dev
+
+# Run the NPM "watch" command to auto-compile your assets when they are changed:
+npm run watch
+```
+
+## 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.

README.md

@@ -3,14 +3,13 @@
 [![Latest Stable Version](https://poser.pugx.org/interaction-design-foundation/nova-html-code-field/v/stable)](https://packagist.org/packages/interaction-design-foundation/nova-html-code-field)
 [![Total Downloads](https://poser.pugx.org/interaction-design-foundation/nova-html-code-field/downloads)](https://packagist.org/packages/interaction-design-foundation/nova-html-code-field)
 
-![image](https://github.com/InteractionDesignFoundation/nova-html-code-field/blob/main/resources/img/[email protected])
-
+Sometimes you need an option to write a raw HTML and have a real-time preview for it.
+This package provides such ability. Under the hood this package uses iframe for HTML code your write,
+so Nova styles will not leak to the preview. Additionally, you can provide URLs to your custom CSS file
+and thus your HTML preview will be very close to the final result.
 
-## ToDo
+![image](https://github.com/InteractionDesignFoundation/nova-html-code-field/blob/main/resources/img/[email protected])
 
-1. Add HTML validator (https://www.npmjs.com/package/html-validator)
-1. Add toolbar
-1. Optimize a preview: re-render only changed node
 
 ## Installation
 
@@ -34,7 +33,7 @@ public function fields()
 
 ### Options
 
- - `->styles(array array $stylesUrls)`:  optional, you can inject your custom css files.
+ - `->styles(array $stylesUrls)`:  optional, you can inject your custom css files.
  - `->previewTemplate(string | \Closure $template)`: optional, wrap editable code to have even better preview.
 
 Full example:
@@ -48,23 +47,20 @@ HtmlCode::make('HTML content')
 
 Please see [Releases](https://github.com/InteractionDesignFoundation/nova-unlayer-field/releases) for more information on what has changed recently.
 
+
 ## Contributing
 
 Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
 
-### Compiling Assets
 
-```bash
-# Compile and minify your assets:
-npm run prod
+## License
 
-# Compile your assets for local development:
-npm run dev
+The MIT License (MIT). Please see [License File](LICENSE) for more information.
 
-# Run the NPM "watch" command to auto-compile your assets when they are changed:
-npm run watch
-```
 
-## License
+## ToDo
+
+1. Add toolbar
+1. Add HTML validator (https://www.npmjs.com/package/html-validator)
+1. Optimize a preview: re-render only changed node
 
-The MIT License (MIT). Please see [License File](LICENSE) for more information.