diff --git a/README.md b/README.md
index 4161ea8dc..8770a873c 100644
--- a/README.md
+++ b/README.md
@@ -17,13 +17,17 @@
- **Are my contributions welcome?**
Yes! Pull requests are encouraged, but please keep them small and focused. Sweeping changes are discouraged and won't be merged (unless the rationale's been thoroughly discussed).
- Please review [The ethos of Radashi](https://github.com/orgs/radashi-org/discussions/20) before submitting a pull request.
+ Please review _“The ethos of Radashi”_ before submitting a pull request:
+
+
+
+
- **Can I help you maintain this?**
Yes! I'll add you as a contributor to the repository. You can review pull requests and even merge them. You can help with closing issues, too. Committing directly to the main branch is a privilege you can earn, as is publishing versions to NPM.
-
+
- **Is backwards compatibility a goal?**
@@ -32,6 +36,25 @@
- **Is there official documentation?**
Currently, there is no documentation beyond this page. I will get to it eventually, but for now, you can refer to the original `radash` documentation [here](https://radash-docs.vercel.app).
+
+
+
+
+- **Automatic releases**
+ To ensure contributions are quickly rolled out, we have the following automatic processes:
+
+ - **Beta releases**
+ Whenever the `main` branch receives a fix or feature, a beta release is automatically published to NPM.
+ Installing `radashi@beta` will always fetch the latest beta release. Beta releases are always audited by the Radashi team.
+
+ - **Preview releases**
+ When the _owner of a PR_ comments `/publish` (and nothing more), the PR is published to NPM under a version like `1.0.0-pr123.f7a9c3b` (i.e. `-pr.`) and a tag like `pr123`. This allows the community to use the changes in the PR without waiting for the PR to be merged.
+
+ - ⚠️ **Beware:** Preview releases are not audited by the Radashi team. Always look at their
+ changes in the PR to ensure no malicious code was introduced.
+
+
+
## Install
```sh
@@ -46,9 +69,17 @@ yarn add radashi
npm install radashi
```
+
+
## Contributing
-Contributions are welcome and appreciated! Check out the [contributing guide](./.github/contributing.md) before you dive in.
+Contributions are welcome and appreciated! Check out the contributing guide before you dive in:
+
+
+
+
+
+
## Changelog
@@ -57,3 +88,11 @@ This section documents the changes between the original `radash` library and thi
### 12.1.0
- Initial release. No differences.
+
+
+
+
+
+
+
+
diff --git a/img/button-apply.png b/img/apply-button.png
similarity index 100%
rename from img/button-apply.png
rename to img/apply-button.png
diff --git a/img/contributing-button.png b/img/contributing-button.png
new file mode 100644
index 000000000..b007bb767
Binary files /dev/null and b/img/contributing-button.png differ
diff --git a/img/docs-button.png b/img/docs-button.png
new file mode 100644
index 000000000..59e3f8916
Binary files /dev/null and b/img/docs-button.png differ
diff --git a/img/ethos-button.png b/img/ethos-button.png
new file mode 100644
index 000000000..6dd6f8ad4
Binary files /dev/null and b/img/ethos-button.png differ
diff --git a/img/footer.png b/img/footer.png
new file mode 100644
index 000000000..38e8443f7
Binary files /dev/null and b/img/footer.png differ