Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve docs + license + readme #229

Merged
merged 3 commits into from
Jan 8, 2023
Merged

Conversation

sodiray
Copy link
Owner

@sodiray sodiray commented Jan 8, 2023

Description

  1. Improve the docs by adding repo and branch to the chiller config. With these, each documentation page will have a source link in the footer.
  2. Improve the license, made it less restrictive by going from BSD 3 Clause -> MIT. Read this for more information.
  3. Added badges to the readme

Checklist

  • Changes are covered by tests if behavior has been changed or added
  • Tests have 100% coverage
  • If code changes were made, the version in package.json has been bumped (matching semver)
  • If code changes were made, the yarn build command has been run and to update the cdn directory
  • If code changes were made, the documentation (in the /docs directory) has been updated

Resolves

n/a

@vercel
Copy link

vercel bot commented Jan 8, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
radash-docs ✅ Ready (Inspect) Visit Preview Jan 8, 2023 at 0:32AM (UTC)

@sodiray sodiray merged commit f1f48c0 into master Jan 8, 2023
@sodiray sodiray deleted the chore/docs-license-readme branch June 27, 2023 13:37
aleclarson referenced this pull request in radashi-org/radashi Jun 24, 2024
* add repo/branch to chiller docs config

* change license to MIT

* add badges to readme
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant