Skip to content

Commit a342007

Browse files
Shreyas Minochamihai-vlc
Shreyas Minocha
authored andcommitted
Make small readme fixes and improvements (#188)
1 parent 1ba03ed commit a342007

File tree

1 file changed

+10
-14
lines changed

1 file changed

+10
-14
lines changed

README.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
11
# VerbalExpressions
22

33
[![Build Status](https://travis-ci.org/VerbalExpressions/JSVerbalExpressions.svg)](https://travis-ci.org/VerbalExpressions/JSVerbalExpressions)
4+
[![Latest Version](https://img.shields.io/npm/v/verbal-expressions.svg)](https://www.npmjs.com/package/verbal-expressions)
5+
[![jsDelivr](https://img.shields.io/badge/dynamic/json.svg?label=jsDelivr&url=https%3A%2F%2Fdata.jsdelivr.com%2Fv1%2Fpackage%2Fnpm%2Fverbal-expressions&query=%24..tags.latest&colorB=blue&prefix=v)](https://www.jsdelivr.com/package/npm/verbal-expressions)
6+
[![License](https://img.shields.io/github/license/VerbalExpressions/JSVerbalExpressions.svg)](LICENSE)
47

58
## JavaScript Regular Expressions made easy
69

7-
VerbalExpressions is a JavaScript library that helps to construct difficult regular expressions.
10+
VerbalExpressions is a JavaScript library that helps construct difficult regular expressions.
811

912
## How to get started
1013

@@ -14,7 +17,7 @@ VerbalExpressions is a JavaScript library that helps to construct difficult regu
1417
<script src="VerbalExpressions.js"></script>
1518
```
1619

17-
Or use the [jsDelivr CDN](http://www.jsdelivr.com/projects/jsverbalexpressions).
20+
Or use the [jsDelivr CDN](https://www.jsdelivr.com/package/npm/verbal-expressions).
1821

1922
### On the server (node.js)
2023

@@ -60,7 +63,7 @@ A source map will also be created in `dist`, so you can use the original "un-bab
6063

6164
## API documentation
6265

63-
You can find the API documentation at [verbalexpressions.github.io/JSVerbalExpressions](https://verbalexpressions.github.io/JSVerbalExpressions).
66+
You can find the API documentation at [verbalexpressions.github.io/JSVerbalExpressions](https://verbalexpressions.github.io/JSVerbalExpressions). You can find the source code for the docs in [`docs`](docs/).
6467

6568
## Examples
6669

@@ -117,18 +120,14 @@ const result = VerEx().find('red').replace('We have a red house', 'blue');
117120
alert(result);
118121
```
119122

120-
## A little word for a big help
121-
122-
I'd like to promote a special thank-you to [Ben Nadel][ben-nadel] for his [great article about extending native JS objects][extending]
123-
124123
## Contributions
125124

126125
Pull requests are warmly welcome!
127126

128127
Clone the repo and fork:
129128

130129
```sh
131-
git clone https://github.com/jehna/VerbalExpressions.git
130+
git clone https://github.com/VerbalExpressions/JSVerbalExpressions.git
132131
```
133132

134133
### Style guide
@@ -137,11 +136,8 @@ The [Airbnb](https://github.com/airbnb/javascript) style guide is loosely used a
137136

138137
Check out these slide decks for handy Github & git tips:
139138

140-
- [Git and Github Secrets](http://zachholman.com/talk/git-github-secrets/)
141-
- [More Git and Github Secrets](http://zachholman.com/talk/more-git-and-github-secrets/)
142-
143-
[ben-nadel]:http://www.bennadel.com/
144-
[extending]:http://www.bennadel.com/blog/2292-extending-javascript-arrays-while-keeping-native-bracket-notation-functionality.htm
139+
- [Git and Github Secrets](https://zachholman.com/talk/git-github-secrets/)
140+
- [More Git and Github Secrets](https://zachholman.com/talk/more-git-and-github-secrets/)
145141

146142
## Tools
147143

@@ -150,7 +146,7 @@ Check out these slide decks for handy Github & git tips:
150146

151147
## Other Implementations
152148

153-
You can see an up to date list of all ports on [VerbalExpressions.github.io](http://VerbalExpressions.github.io).
149+
You can see an up to date list of all ports on [VerbalExpressions.github.io](https://VerbalExpressions.github.io).
154150

155151
- [Ruby](https://github.com/ryan-endacott/verbal_expressions)
156152
- [C#](https://github.com/VerbalExpressions/CSharpVerbalExpressions)

0 commit comments

Comments
 (0)