Skip to content
This repository has been archived by the owner on Nov 15, 2024. It is now read-only.

docs: add license and readme #13

Merged
merged 7 commits into from
Nov 15, 2024
Merged

docs: add license and readme #13

merged 7 commits into from
Nov 15, 2024

Conversation

bjohansebas
Copy link
Owner

The necessary documentation is added to be moved to the Express organization

closes #12

LICENSE Outdated Show resolved Hide resolved
@bjohansebas
Copy link
Owner Author

I added a workflow to automate the use of the package, so it stays updated after each PR. It will be useful when others want to add more options but don't update the README

@bjohansebas bjohansebas marked this pull request as ready for review November 11, 2024 23:38
Comment on lines +3 to +6
[![NPM Version][npm-version-image]][npm-url]
[![NPM Install Size][npm-install-size-image]][npm-install-size-url]
[![NPM Downloads][npm-downloads-image]][npm-downloads-url]
[![OpenSSF Scorecard Badge][ossf-scorecard-badge]][ossf-scorecard-visualizer]
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will not display correctly yet, but once it's published and moved to Express, it will be displayed properly.

@bjohansebas bjohansebas changed the title [WIP] docs: add license and readme docs: add license and readme Nov 11, 2024
@bjohansebas
Copy link
Owner Author

@kjugi If you think the texts can be improved, feel free to change them

Copy link
Contributor

@kjugi kjugi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

small comments

.github/workflows/generate-readme.yml Show resolved Hide resolved
.github/actions/generate-help-docs.mjs Show resolved Hide resolved
.github/workflows/generate-readme.yml Show resolved Hide resolved
@bjohansebas bjohansebas added the documentation Improvements or additions to documentation label Nov 12, 2024
@bjohansebas bjohansebas merged commit e64c5d1 into main Nov 15, 2024
9 checks passed
@bjohansebas bjohansebas deleted the docs branch November 15, 2024 00:14
@bjohansebas
Copy link
Owner Author

@kjugi I'm going to send the request to move this repository to Express.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Before Moving to Express org
2 participants