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

docs: small adjustments to README #157

Merged
merged 2 commits into from
Aug 11, 2022
Merged

docs: small adjustments to README #157

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
278d771
Update README.md
tooomm Aug 11, 2022
3767a87
Update README.md
tooomm Aug 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
23 changes: 12 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,8 @@

Quickly check links in Markdown, HTML, and text files using [lychee].

When used in conjunction with [Create Issue From
File](https://github.com/peter-evans/create-issue-from-file), issues will be
created when the action finds link problems.
When used in conjunction with [Create Issue From File], issues will be
opened when the action finds link problems.

## Usage

Expand Down Expand Up @@ -200,25 +199,27 @@ For example:

## Credits

This action is based on
[peter-evans/link-checker](https://github.com/peter-evans/link-checker) and uses
lychee (written in Rust) instead of liche (written in Go) for link checking. For
a comparison of both tools, check out this [comparison
table](https://github.com/lycheeverse/lychee#features).
This action is based on the deprecated [peter-evans/link-checker] and uses
[lychee] (written in Rust) instead of liche (written in Go) for link checking.

## License

lychee is licensed under either of

- Apache License, Version 2.0, (LICENSE-APACHE or
https://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or https://choosealicense.com/licenses/mit/)
- [Apache License, Version 2.0] ([LICENSE-APACHE](./LICENSE-APACHE))
- [MIT License] ([LICENSE-MIT](./LICENSE-MIT))

at your option.



[lychee]: https://github.com/lycheeverse/lychee
[lychee-args]: https://github.com/lycheeverse/lychee#commandline-parameters
[lychee-exit]: https://github.com/lycheeverse/lychee#exit-codes
[troubleshooting]: https://github.com/lycheeverse/lychee/blob/master/docs/TROUBLESHOOTING.md
[security]: https://francoisbest.com/posts/2020/the-security-of-github-actions
[dependabot]: https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
[peter-evans/link-checker]: https://github.com/peter-evans/link-checker
[Create Issue From File]: https://github.com/peter-evans/create-issue-from-file
[Apache License, Version 2.0]: https://www.apache.org/licenses/LICENSE-2.0
[MIT License]: https://choosealicense.com/licenses/mit