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.

Sign up for GitHub

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

Jump to bottom

fix(readme): broken docs link on readme #32

Merged
merged 6 commits into from
Jul 5, 2024
Merged

fix(readme): broken docs link on readme #32

merged 6 commits into from
Jul 5, 2024

Conversation

kieranroneill
Copy link
Collaborator

@kieranroneill kieranroneill commented Jul 5, 2024 •
edited
Loading

Description

  • Fix broken docs link in README.md
  • Add weeky npm downloads badge in README.md
  • Fix badges in README.md
  • Add social contract details to README.md
  • Update package.json:
    • Add homepage property to point to the docs
    • Add @elliotBraem as a contributor
    • Add bugs property

Type of change

  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 🏗️ Build configuration (CI configuration, scaffolding etc.)
  • 🐛 Bug fix (non-breaking change which fixes an issue)
  • 📝 Documentation update(s)
  • 📦 Dependency update(s)
  • 👩🏽‍💻 Improve developer experience
  • ⚡ Improve performance
  • ✨ New feature (non-breaking change which adds functionality)
  • ♻ Refactor
  • ⏪ Revert changes
  • 🧪 New tests or updates to existing tests

@kieranroneill kieranroneill added the 📝 documentation Improvements or additions to documentation label Jul 5, 2024
@kieranroneill kieranroneill self-assigned this Jul 5, 2024
@kieranroneill kieranroneill changed the title docs(readme): broken docs link on readme fix(readme): broken docs link on readme Jul 5, 2024
@kieranroneill kieranroneill merged commit b5235e4 into main Jul 5, 2024
5 checks passed
@kieranroneill kieranroneill deleted the docs/broken-docs-link-on-readme branch July 5, 2024 13:19
github-actions bot pushed a commit that referenced this pull request Jul 5, 2024
chore(release): 1.0.1
b8bb3cb 
## [1.0.1](v1.0.0...v1.0.1) (2024-07-05)

### Bug Fixes

* **readme:** broken docs link on readme ([#32](#32)) ([b5235e4](b5235e4))
@kieranroneill
Copy link
Collaborator Author

🎉 This PR is included in version 1.0.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@kieranroneill kieranroneill added the 🚀 released To the moon! label Jul 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@kieranroneill kieranroneill

Labels
📝 documentation Improvements or additions to documentation 🚀 released To the moon!
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@kieranroneill