Update library docs (kommitters#34)

* Update library docs

* Add v0.2.0 changelog

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,37 @@
+---
+name: 🐞 Bug report
+about: Tell us about a bug you found
+title: ''
+labels: '🐞 Bug, ⛑ Needs triage'
+assignees: ''
+
+---
+
+### Precheck
+
+- [ ] Do a quick search and make sure the bug has not been reported yet.
+- [ ] Please disclose security vulnerabilities privately at [[email protected]](mailto:[email protected]).
+- [ ] Finally, be nice and have fun!.
+
+### Description
+
+A clear and concise description of what the bug is.
+
+### Environment
+
+* Editor.js version:
+* Plugins you use with their versions:
+* Device, Browser, OS:
+
+### Current behavior
+
+Include code samples, errors and stack traces if appropriate.
+If reporting a bug, please include the reproducing steps.
+
+### Expected behavior
+
+A clear and concise description of what you expected to happen.
+
+### Additional context
+
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,24 @@
+---
+name: 👋 Feature request
+about: Tell us what you'd like to see
+title: ''
+labels: '👍 Feature, ⛑ Needs triage'
+assignees: ''
+
+---
+
+### Is your feature request related to a problem? Please describe.
+
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+### Describe the solution you'd like
+
+A clear and concise description of what you want to happen.
+
+### Describe alternatives you've considered
+
+A clear and concise description of any alternative solutions or features you've considered.
+
+### Additional context
+
+Add any other context or screenshots about the feature request here.

.github/workflows/tests.yml → .github/workflows/ci.yml

@@ -1,6 +1,10 @@
 name: CI
-
-on: [pull_request, pull_request_target]
+on:
+  push:
+    branches:
+      - master
+      - 'v*.[0-9]'
+  pull_request:
 
 jobs:
   build:

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.2.0 (09.09.2021)
+
+* Added a CI workflow with Github actions.
+* Updated packages with known security breaches.
+* Docs updated.
+
 ## 0.1.4 (28.06.2021)
 
 * Updated bundle file.

CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community includes:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing other's private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at [[email protected]](mailto:[email protected]).
+
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
+at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

@@ -1,18 +1,61 @@
-# Contributing and Development
+# How to contribute
 
-## Development Setup
+First off, thanks for taking the time to contribute, it is encouraging! 🎉🙌
 
-1. Clone the repo
-2. Install dependencies running `yarn`
-3. To create a build in development mode, run `yarn build:dev`
-4. To create a production bundle, run `yarn build`
-5. Run tests with `yarn test`
+We want to make it as easy as possible to contribute changes that help the [EditorJS Unsplash Inline Image][repo] library to grow and thrive. There are a few guidelines that we ask contributors to follow so that we can merge your changes quickly.
 
-## Submitting Changes
+## Getting started
 
-1. Fork the project
-2. Create a new topic branch to contain your feature, change, or fix.
-3. Make sure all the tests are still passing.
-4. Implement your feature, change, or fix. Make sure to write tests, update and/or add documentation.
-5. Push your topic branch up to your fork.
-6. Open a Pull Request with a clear title and description.
+* Make sure you have a [GitHub account](https://github.com/signup/free).
+* Create a GitHub issue for your contribution, assuming one does not already exist.
+  * Clearly describe the issue including steps to reproduce if it is a bug.
+* Fork the repository on GitHub.
+* Try to keep your local repository in a "rebased" state.
+* Set the project up.
+  * Install the dependencies running `yarn`.
+  * To create a build in development mode, run `yarn build:dev`.
+  * To create a production bundle, run `yarn build`.
+  * Run tests with `yarn test`.
+
+## Finding things to work on
+
+The first place to start is always looking over the current GitHub issues for the project you are
+interested in contributing to. Issues marked with [good first issue][good-first-issue] or [help wanted][help-wanted] are usually pretty self-contained and a good place to get started.
+
+If you see any issues that are assigned to a particular person or have the `work in progress` label, that means
+someone is currently working on that issue this issue in the next week or two.
+
+Of course, feel free to create a new issue if you think something needs to be added or fixed.
+
+## Making changes
+
+* Create a topic branch from where you want to base your work.
+  * This is usually the `main|master` branch.
+  * Please avoid working directly on the `main|master` branch.
+* Make sure you have added the necessary tests for your changes and make sure all tests pass.
+* Make sure your code is properly formatted by running `mix format`.
+
+## Submitting changes
+
+* All content, comments, pull requests and other contributions must comply with the
+  [Code of Conduct][coc].
+* Push your changes to a topic branch in your fork of the repository.
+* Submit a pull request.
+  * Include a descriptive [commit message][commit-msg].
+  * Changes contributed via pull request should focus on a single issue at a time.
+  * Rebase your local changes against the `main|master` branch. Resolve any conflicts that arise.
+
+At this point, you're waiting on us. We like to at least comment on pull requests within three
+business days (typically, one business day). We may suggest some changes, improvements or
+alternatives.
+
+## Additional resources
+
+* [EditorJS](https://editorjs.io/)
+* #get in touch: [[email protected]](mailto:[email protected]) | [@kommitters_oss](https://twitter.com/kommitters_oss) on twitter.
+
+[repo]: https://github.com/kommitters/editorjs-inline-image
+[coc]: https://github.com/kommitters/editorjs-inline-image/blob/master/CODE_OF_CONDUCT.md
+[commit-msg]: https://github.com/erlang/otp/wiki/Writing-good-commit-messages
+[good-first-issue]: https://github.com/kommitters/editorjs-inline-image/issues?q=label%3A%22%F0%9F%91%8B+Good+first+issue%22
+[help-wanted]: https://github.com/kommitters/editorjs-inline-image/issues?q=label%3A%22%F0%9F%86%98+Help+wanted%22

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 kommit
+Copyright (c) 2021 kommitters Open Source
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,16 +1,16 @@
 ![](https://badgen.net/badge/Editor.js/v2.0/blue)
 
-# EditorJS Inline Image Tool
+# EditorJS Unsplash Inline Image Tool
 
 Image tool for [Editor.js](https://editorjs.io).
 
-Embed images from image files, URLs or [Unsplash](https://unsplash.com/).
+Embed images from [Unsplash](https://unsplash.com/), blob or URLs.
 
 ![](assets/demo.gif)
 
 ## Notes
 
-Requires no server-side uploader.
+Do not require a server-side uploader.
 
 Built following the [Unsplash API Guidelines](https://help.unsplash.com/en/articles/2511245-unsplash-api-guidelines).
 
@@ -98,20 +98,20 @@ const editor = EditorJS({
 **Unsplash image**
 
 ```json
-        {
-            "type": "image",
-            "data": {
-                "url": "https://images.unsplash.com/photo-xxxxxxxxxxxxxxxxx",
-                "caption": "An image from Unsplash",
-                "withBorder": false,
-                "withBackground": true,
-                "stretched": false,
-                "unsplash": {
-                    "author": "John Doe",
-                    "profileLink": "https://unsplash.com/@john_doe_fake"
-                }
-            }
-        }
+{
+  "type": "image",
+  "data": {
+    "url": "https://images.unsplash.com/photo-xxxxxxxxxxxxxxxxx",
+    "caption": "An image from Unsplash",
+    "withBorder": false,
+    "withBackground": true,
+    "stretched": false,
+    "unsplash": {
+      "author": "John Doe",
+      "profileLink": "https://unsplash.com/@john_doe_fake"
+    }
+  }
+}
 ```
 
 ## Development
@@ -134,14 +134,22 @@ $ yarn build
 $ yarn test
 ```
 
-## Contributing and Development
-Bug reports and pull requests are welcome on GitHub https://github.com/kommitters/editorjs-inline-image. Everyone is welcome to participate in the project. If you are thinking about contributing to the project, please check our [Contributing Guide](https://github.com/kommitters/editorjs-inline-image/blob/master/CONTRIBUTING.md).
+## Code of conduct
+We welcome everyone to contribute. Make sure you have read the [CODE_OF_CONDUCT][coc] before.
+
+## Contributing
+For information on how to contribute, please refer to our [CONTRIBUTING][contributing] guide.
 
 ## Changelog
-See the [CHANGELOG](https://github.com/kommitters/editorjs-inline-image/blob/master/CHANGELOG.md) for versions details.
+Features and bug fixes are listed in the [CHANGELOG][changelog] file.
 
 ## License
-See [LICENSE](https://github.com/kommitters/editorjs-inline-image/blob/master/LICENSE) for details.
+This library is licensed under an MIT license. See [LICENSE][license] for details.
+
+## Acknowledgements
+Made with 💙 by [kommitters Open Source](https://kommit.co)
 
-## Credits
-Made with 💙 by [kommit](https://kommit.co)
+[license]: https://github.com/kommitters/editorjs-inline-image/blob/master/LICENSE
+[coc]: https://github.com/kommitters/editorjs-inline-image/blob/master/CODE_OF_CONDUCT.md
+[changelog]: https://github.com/kommitters/editorjs-inline-image/blob/master/CHANGELOG.md
+[contributing]: https://github.com/kommitters/editorjs-inline-image/blob/master/CONTRIBUTING.md