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

docs: Update README with pre-built image and license info #136

Merged
merged 1 commit into from
Oct 7, 2024

Conversation

JackPlowman
Copy link
Owner

@JackPlowman JackPlowman commented Oct 7, 2024

Pull Request

Description

This update enhances the README.md file with additional information and improvements:

  • Added a new section for GitHub Action Pre-built Image, providing instructions on how to use the pre-built Docker image in workflows.
  • Included a tip recommending the use of the pre-built Docker image for faster installation.
  • Updated the GitHub Action Inputs table, changing github-token to GITHUB_TOKEN for consistency.
  • Added a new License section with a link to the MIT license file.
  • Updated the table of contents to reflect the new sections.

These changes provide users with more options for implementation and clearer guidance on using the GitHub Stats Analyser.

fixes #137

@JackPlowman JackPlowman changed the title Add Documentation for GitHub Package docs: Update README with pre-built image and license info Oct 7, 2024
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 7, 2024
Copy link
Owner Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @JackPlowman and the rest of your teammates on Graphite Graphite

@JackPlowman JackPlowman marked this pull request as ready for review October 7, 2024 07:10
Copy link

sonarcloud bot commented Oct 7, 2024

@JackPlowman JackPlowman merged commit 9ddc6f9 into main Oct 7, 2024
41 checks passed
Copy link
Owner Author

Merge activity

@JackPlowman JackPlowman deleted the 10-07-add_documentation_for_github_package branch October 7, 2024 07:12
JackPlowman added a commit that referenced this pull request Oct 20, 2024
🤖 I have created a release *beep* *boop*
---


##
[1.2.0](v1.1.0...v1.2.0)
(2024-10-20)


### 🚀 Features

* Add Debug Mode
([#160](#160))
([2249da5](2249da5)),
closes
[#159](#159)


### 📝 Documentation

* Update README with pre-built image and license info
([#136](#136))
([9ddc6f9](9ddc6f9)),
closes
[#137](#137)


### 🧰 Maintenance

* Add Configuration class and refactor repository retrieval
([#156](#156))
([15425e6](15425e6)),
closes
[#154](#154)
* Add setup-dependencies directory to Dependabot config
([#133](#133))
([44ec79d](44ec79d)),
closes
[#134](#134)
* Add test action and output validation
([#147](#147))
([040eaa8](040eaa8)),
closes
[#148](#148)
* Add version check workflow and version file
([#145](#145))
([19dd4aa](19dd4aa)),
closes
[#146](#146)
* Bump Python Version to Python 3.13
([#140](#140))
([3135efc](3135efc)),
closes
[#139](#139)
* Fix Docker image reference in action.yml
([#149](#149))
([bbfd6f1](bbfd6f1)),
closes
[#150](#150)
* Force color output in logs
([#164](#164))
([2d0d5da](2d0d5da)),
closes
[#163](#163)
* Optimise pre-commit hook for Python files
([#142](#142))
([8e48442](8e48442)),
closes
[#141](#141)
* Reduce log verbosity
([#165](#165))
([1c78547](1c78547)),
closes
[#162](#162)
* Reduce Verbose Logging
([#158](#158))
([94fea82](94fea82)),
closes
[#157](#157)
* Refactor GitHub Action structure and usage
([#143](#143))
([fc7d2d6](fc7d2d6)),
closes
[#144](#144)
* Simplify Docker build job name and description
([#166](#166))
([d94299f](d94299f)),
closes
[#167](#167)
* Update workflow trigger conditions
([#168](#168))
([f96a17a](f96a17a)),
closes
[#169](#169)

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation on using packaged container
1 participant