Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
aleclarson committed Jun 24, 2024
1 parent 8f0c3f1 commit 3e61d98
Show file tree
Hide file tree
Showing 6 changed files with 42 additions and 3 deletions.
45 changes: 42 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

<a href="https://github.com/orgs/radashi-org/discussions/20">
<img src="https://github.com/radashi-org/radashi/raw/main/img/ethos-button.png" alt="The ethos of Radashi" width="200px" />
</a>

- **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.

<a href="https://github.com/orgs/radashi-org/discussions/4">
<img src="https://github.com/radashi-org/radashi/raw/main/img/button-apply.png" alt="Apply to join the Radashi team" width="200px" />
<img src="https://github.com/radashi-org/radashi/raw/main/img/apply-button.png" alt="Apply to join the Radashi team" width="200px" />
</a>

- **Is backwards compatibility a goal?**
Expand All @@ -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).

<a href="https://radash-docs.vercel.app">
<img src="https://github.com/radashi-org/radashi/raw/main/img/docs-button.png" alt="Radash documentation" width="200px" />
</a>

- **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. `<latest version>-pr<PR number>.<commit SHA>`) 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.

&nbsp;

## Install

```sh
Expand All @@ -46,9 +69,17 @@ yarn add radashi
npm install radashi
```

&nbsp;

## 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:

<a href="https://github.com/radashi-org/radashi/raw/main/.github/contributing.md">
<img src="https://github.com/radashi-org/radashi/raw/main/img/contributing-button.png" alt="Contributing to Radashi" width="200px" />
</a>

&nbsp;

## Changelog

Expand All @@ -57,3 +88,11 @@ This section documents the changes between the original `radash` library and thi
### 12.1.0

- Initial release. No differences.

&nbsp;

<div align="center">
<p align="center">
<img src="https://github.com/radashi-org/radashi/raw/main/img/footer.png" alt="Radashi" width="100%" />
</p>
</div>
File renamed without changes
Binary file added img/contributing-button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/docs-button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/ethos-button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/footer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3e61d98

Please sign in to comment.