Skip to content

Commit

Permalink
Clean up markdown links and examples.
Browse files Browse the repository at this point in the history
  • Loading branch information
Potherca committed Jul 16, 2020
1 parent bc0eff0 commit 56f8ad2
Showing 1 changed file with 37 additions and 45 deletions.
82 changes: 37 additions & 45 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,12 +48,12 @@ providers.
This can quite easily be achieved using the excellent service provided by
[Shields.io](https://shields.io/):

1. [![Project Stage Badge: Concept][Project Stage Badge: Concept]][Project Stage Page]
2. [![Project Stage Badge: Research][Project Stage Badge: Research]][Project Stage Page]
3. [![Project Stage Badge: Experimental][Project Stage Badge: Experimental]][Project Stage Page]
4. [![Project Stage Badge: Development][Project Stage Badge: Development]][Project Stage Page]
5. [![Project Stage Badge: Production Ready][Project Stage Badge: Production Ready]][Project Stage Page]
6. [![Project Stage Badge: DEPRECATED][Project Stage Badge: DEPRECATED]][Project Stage Page]
1. [![Project stage: Concept][project-stage-badge: Concept]][project-stage-page]
2. [![Project stage: Research][project-stage-badge: Research]][project-stage-page]
3. [![Project stage: Experimental][project-stage-badge: Experimental]][project-stage-page]
4. [![Project stage: Development][project-stage-badge: Development]][project-stage-page]
5. [![Project stage: Production Ready][project-stage-badge: Production Ready]][project-stage-page]
6. [![Project stage: DEPRECATED][project-stage-badge: DEPRECATED]][project-stage-page]
7. <i>no image required</i>

## Usage
Expand All @@ -68,106 +68,103 @@ The link for all badges is the same, pointing to this page.
#### HTML

```
<img src="https://img.shields.io/badge/Project%20Stage-Concept-red.svg" />
<img alt="Project stage: Concept" src="https://img.shields.io/badge/Project%20Stage-Concept-red.svg" />
```

#### Markdown

```
[![Project Stage Badge: Concept][Project Stage Page]
[![Project stage: Concept][project-stage-badge: Concept]][project-stage-page]
[Project Stage Badge: Concept]: https://img.shields.io/badge/Project%20Stage-Concept-red.svg
[Project Stage Page]: https://blog.pother.ca/project-stages/
[project-stage-badge: Concept]: https://img.shields.io/badge/Project%20Stage-Concept-red.svg
[project-stage-page]: https://blog.pother.ca/project-stages/
```

### Research

#### HTML

```
<img src="https://img.shields.io/badge/Project%20Stage-Research-orange.svg" />
<img alt="Project stage: Research" src="https://img.shields.io/badge/Project%20Stage-Research-orange.svg" />
```

#### Markdown

```
[![Project Stage Badge: Research][Project Stage Page]
[![Project stage: Research][project-stage-badge: Research]][project-stage-page]
[Project Stage Badge: Research]: https://img.shields.io/badge/Project%20Stage-Research-orange.svg
[Project Stage Page]: https://blog.pother.ca/project-stages/
[project-stage-badge: Research]: https://img.shields.io/badge/Project%20Stage-Research-orange.svg
[project-stage-page]: https://blog.pother.ca/project-stages/
```

### Experimental

#### HTML

```
<img src="https://img.shields.io/badge/Project%20Stage-Experimental-yellow.svg" />
<img alt="Project stage: Experimental" src="https://img.shields.io/badge/Project%20Stage-Experimental-yellow.svg" />
```

#### Markdown

```
[![Project Stage Badge: Experimental][Project Stage Page]
[![Project stage: Experimental][project-stage-badge: Experimental]][project-stage-page]
[Project Stage Badge: Experimental]: https://img.shields.io/badge/Project%20Stage-Experimental-yellow.svg
[Project Stage Page]: https://blog.pother.ca/project-stages/
[project-stage-badge: Experimental]: https://img.shields.io/badge/Project%20Stage-Experimental-yellow.svg
[project-stage-page]: https://blog.pother.ca/project-stages/
```

### Development

#### HTML

```
<img src="https://img.shields.io/badge/Project%20Stage-Development-yellowgreen.svg" />
<img alt="Project stage: Development" src="https://img.shields.io/badge/Project%20Stage-Development-yellowgreen.svg" />
```

#### Markdown

```
[![Project Stage Badge: Development][Project Stage Page]
[![Project stage: Development][project-stage-badge: Development]][project-stage-page]
[Project Stage Badge: Development]: https://img.shields.io/badge/Project%20Stage-Development-yellowgreen.svg
[Project Stage Page]: https://blog.pother.ca/project-stages/
[project-stage-badge: Development]: https://img.shields.io/badge/Project%20Stage-Development-yellowgreen.svg
[project-stage-page]: https://blog.pother.ca/project-stages/
```

### Production Ready

#### HTML

```
<img src="https://img.shields.io/badge/Project%20Stage-Production%20Ready-brightgreen.svg" />
<img alt="Project stage: Production Ready" src="https://img.shields.io/badge/Project%20Stage-Production%20Ready-brightgreen.svg" />
```

#### Markdown

```
[![Project Stage Badge: Production Ready][Project Stage Page]
[![Project stage: Production Ready][project-stage-badge: Production Ready]][project-stage-page]
[Project Stage Badge: Production Ready]: https://img.shields.io/badge/Project%20Stage-Production%20Ready-brightgreen.svg
[Project Stage Page]: https://blog.pother.ca/project-stages/
[project-stage-badge: Production Ready]: https://img.shields.io/badge/Project%20Stage-Production%20Ready-brightgreen.svg
[project-stage-page]: https://blog.pother.ca/project-stages/
```

### DEPRECATED

#### HTML

```
<img src="https://img.shields.io/badge/Project%20Stage-%20!%20DEPRECATED%20%20%20!-ff0000.svg" />
<img alt="Project stage: DEPRECATED" src="https://img.shields.io/badge/Project%20Stage-%20!%20DEPRECATED%20%20%20!-ff0000.svg" />
```

#### Markdown

```
[![Project Stage Badge: DEPRECATED][Project Stage Page]
[![Project stage: DEPRECATED][project-stage-badge: DEPRECATED]][project-stage-page]
[Project Stage Badge: DEPRECATED]: https://img.shields.io/badge/Project%20Stage-%20!%20DEPRECATED%20%20%20!-ff0000.svg
[Project Stage Page]: https://blog.pother.ca/project-stages/
[project-stage-badge: DEPRECATED]: https://img.shields.io/badge/Project%20Stage-%20!%20DEPRECATED%20%20%20!-ff0000.svg
[project-stage-page]: https://blog.pother.ca/project-stages/
```


- - -

Any questions or feedback can be Tweeted to [@potherca](https://twitter.com/intent/tweet?screen_name=potherca)

<p class="created-by">
Expand All @@ -176,15 +173,10 @@ Any questions or feedback can be Tweeted to [@potherca](https://twitter.com/inte
&mdash; Created by <a href="https://pother.ca/" class="potherca">Potherca</a>
</p>

[Project Stage Badge: Concept]: https://img.shields.io/badge/Project%20Stage-Concept-red.svg
[Project Stage Page]: https://blog.pother.ca/project-stages/
[Project Stage Badge: Research]: https://img.shields.io/badge/Project%20Stage-Research-orange.svg
[Project Stage Page]: https://blog.pother.ca/project-stages/
[Project Stage Badge: Experimental]: https://img.shields.io/badge/Project%20Stage-Experimental-yellow.svg
[Project Stage Page]: https://blog.pother.ca/project-stages/
[Project Stage Badge: Development]: https://img.shields.io/badge/Project%20Stage-Development-yellowgreen.svg
[Project Stage Page]: https://blog.pother.ca/project-stages/
[Project Stage Badge: Production Ready]: https://img.shields.io/badge/Project%20Stage-Production%20Ready-brightgreen.svg
[Project Stage Page]: https://blog.pother.ca/project-stages/
[Project Stage Badge: DEPRECATED]: https://img.shields.io/badge/Project%20Stage-%20!%20DEPRECATED%20%20%20!-ff0000.svg
[Project Stage Page]: https://blog.pother.ca/project-stages/
[project-stage-badge: Concept]: https://img.shields.io/badge/Project%20Stage-Concept-red.svg
[project-stage-badge: DEPRECATED]: https://img.shields.io/badge/Project%20Stage-%20!%20DEPRECATED%20%20%20!-ff0000.svg
[project-stage-badge: Development]: https://img.shields.io/badge/Project%20Stage-Development-yellowgreen.svg
[project-stage-badge: Experimental]: https://img.shields.io/badge/Project%20Stage-Experimental-yellow.svg
[project-stage-badge: Production Ready]: https://img.shields.io/badge/Project%20Stage-Production%20Ready-brightgreen.svg
[project-stage-badge: Research]: https://img.shields.io/badge/Project%20Stage-Research-orange.svg
[project-stage-page]: https://blog.pother.ca/project-stages/

0 comments on commit 56f8ad2

Please sign in to comment.