Installs into .claude/skills of the current project.
Are you the author of Readme?
Add the live security badge to your README. It updates with every re-scan.
[](https://www.skillsdirectory.com/skills/jesperancinha-readme-whiskers-kotlin-native)
---
name: Readme standards
description: Conventions to use in Readme files
---
## 1. Remove the usage of unresolved anchors
Unresolved anchors that don't translate to a link or a website should be removed.
The most important examples of this are the usage of `(#)`. This used to be a guarantee that the image would be displayed.
This is no longer necessary, and the svg icons get generated with or without the link.
### Example 1
Replace
```text
[](#)
```
with
```text
```
## 2. Don't use obsolete HTML properties for showing images with divs
1. Replace usages of `<div align="center">` with `<div style="text-align: center;">`
2. If the `alt` attribute is missing from the `img` node, please add it with the text of the `a` (anchor), property value of its `title` property.
### Example 1
Replace
```html
<div align="center">
<a title="Learning JWT security using KumuluzEE — The finances of a league of the environment" href="https://itnext.io/learning-jwt-security-using-kumuluzee-the-finances-of-a-league-of-the-environment-2f541e99cc90">
<img
src="./docs/images/articles.your.finance.intro.png"
style="width:100%;">
</a>
</div>
```
with
```html
<div style="text-align: center;">
<a title="Learning JWT security using KumuluzEE — The finances of a league of the environment" href="https://itnext.io/learning-jwt-security-using-kumuluzee-the-finances-of-a-league-of-the-environment-2f541e99cc90">
<img
src="./docs/images/articles.your.finance.intro.png"
style="width:100%;" alt="Learning JWT security using KumuluzEE — The finances of a league of the environment">
</a>
</div>
```
## 3. Remove obsolete badges
Some badges are no longer usable and don't work because some of the frameworks they used have been discontinued.
For all `.md` files, or other markdown files, please remove badges from the following list:
1. [![codebeat badge]()]() - All codebeat badges should be removed, along with any references to using it.
2. [![BCH compliance]()]() - All BCH badges should be removed, along with any references to using it.
## 4. `.md` files in Submodules, or subfolders, should not contain any of the following badges
The following badges are applied to the whole project, hence why it makes no sense to keep them in submodules or subfolders.
These badges should only be part of root `Readme.md` files. They should also be removed from other .md files if found.
1. ![Twitter URL]()]()
2. ![Generic badge]()]()
3. ![GitHub release]()]()
4. ![GitHub License]()]()
5. ![CircleCI]()]()
6. ![Build status]()]()
7. ](https://github.com/jesperancinha/jeorg-spring-master-test-drives/actions/workflows/jeorg-spring-master-test-drives.yml)
8. ![Codacy Badge]()]()
9. ![codebeat badge]()]()
10. ![BCH compliance]()]()
11. ![Known Vulnerabilities]()]()
12. ![Codacy Badge]()]()
13. ![Coverage Status]()]()
14. ![codecov]()]()
15. ![GitHub language count]()]()
16. ![GitHub top language]()]()
17. ![GitHub top language]()]()
The pipeline GitHub action badges usually have the name of the project. They usually have `actions/workflows` in the links.
These should only be part of root `Readme.md` files. They should also be removed from other .md files if found.
## 5. Please remove emojis from badges
There may be other badges with emojis in their presentation text.
Most of these bages are the Generic one:
[![Generic badge]()]()
Look for these badges and simply remove the emoji from the presentation text, if any is found.
