Skip to content

Commit 94c33a3

Browse files
rzatsBenFradet
authored andcommitted
Update README markdown in according with CommonMark (closes snowplow-referer-parser#165)
1 parent be86377 commit 94c33a3

File tree

8 files changed

+56
-56
lines changed

8 files changed

+56
-56
lines changed

README.md

+29-29
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
Java/Scala: [![Build Status](https://travis-ci.org/snowplow/referer-parser.png)](https://travis-ci.org/snowplow/referer-parser)
44

5-
referer-parser is a database for extracting marketing attribution data (such as search terms) from referer URLs, inspired by the [ua-parser] [ua-parser] project (an equivalent library for user agent parsing).
5+
referer-parser is a database for extracting marketing attribution data (such as search terms) from referer URLs, inspired by the [ua-parser][ua-parser] project (an equivalent library for user agent parsing).
66

77
The referer-parser project also contains multiple libraries for working with the referer-parser database in different languages.
88

9-
referer-parser is a core component of [Snowplow] [snowplow], the open-source web-scale analytics platform powered by Hadoop and Redshift.
9+
referer-parser is a core component of [Snowplow][snowplow], the open-source web-scale analytics platform powered by Hadoop and Redshift.
1010

1111
_Note that we always use the original HTTP misspelling of 'referer' (and thus 'referal') in this project - never 'referrer'._
1212

@@ -24,14 +24,14 @@ If there is an issue with the database necessitating a re-release within the mon
2424

2525
## Maintainers
2626

27-
* Java/Scala: [Snowplow Analytics Ltd] [snowplow-analytics]
28-
* Ruby: [Kelley Reynolds] [kreynolds] at Inside Systems, Inc
29-
* Python: [Don Spaulding] [donspaulding]
30-
* node.js (JavaScript): [Martin Katrenik] [mkatrenik]
31-
* .NET (C#): [Sepp Wijnands] [swijnands] at [iPerform Software] [iperform]
32-
* PHP: [Lars Strojny] [lstrojny]
33-
* Go: [Thomas Sileo] [tsileo]
34-
* `referers.yml`: [Snowplow Analytics] [snowplow-analytics]
27+
* Java/Scala: [Snowplow Analytics Ltd][snowplow-analytics]
28+
* Ruby: [Kelley Reynolds][kreynolds] at Inside Systems, Inc
29+
* Python: [Don Spaulding][donspaulding]
30+
* node.js (JavaScript): [Martin Katrenik][mkatrenik]
31+
* .NET (C#): [Sepp Wijnands][swijnands] at [iPerform Software][iperform]
32+
* PHP: [Lars Strojny][lstrojny]
33+
* Go: [Thomas Sileo][tsileo]
34+
* `referers.yml`: [Snowplow Analytics][snowplow-analytics]
3535

3636
## Usage: Java
3737

@@ -53,7 +53,7 @@ System.out.println(r.source); // => "Google"
5353
System.out.println(r.term); // => "gateway oracle cards denise linn"
5454
```
5555

56-
For more information, please see the Java/Scala [README] [java-scala-readme].
56+
For more information, please see the Java/Scala [README][java-scala-readme].
5757

5858
## Usage: Scala
5959

@@ -97,7 +97,7 @@ for (r <- Parser.parse(refererUrl, pageUrl, internalDomains)) {
9797
}
9898
```
9999

100-
For more information, please see the Java/Scala [README] [java-scala-readme].
100+
For more information, please see the Java/Scala [README][java-scala-readme].
101101

102102
## Usage: Ruby
103103

@@ -118,7 +118,7 @@ parser.parse('http://www.google.com/search?q=gateway+oracle+cards+denise+linn&hl
118118
}
119119
```
120120

121-
For more information, please see the Ruby [README] [ruby-readme].
121+
For more information, please see the Ruby [README][ruby-readme].
122122

123123
## Usage: Python
124124

@@ -154,7 +154,7 @@ curr_url = 'http://www.snowplowanalytics.com/account/profile'
154154
r = Referer(referer_url, curr_url)
155155
```
156156

157-
For more information, please see the Python [README] [python-readme].
157+
For more information, please see the Python [README][python-readme].
158158

159159
## Usage: node.js
160160

@@ -183,7 +183,7 @@ var current_url = 'http://www.snowplowanalytics.com/account/profile'
183183
var r = Referer(referer_url, current_url)
184184
```
185185

186-
For more information, please see the node.js [README] [nodejs-readme].
186+
For more information, please see the node.js [README][nodejs-readme].
187187

188188
## Usage: .NET
189189

@@ -204,7 +204,7 @@ Console.WriteLine(r.Source); // => "Google"
204204
Console.WriteLine(r.Term); // => "gateway oracle cards denise linn"
205205
```
206206

207-
For more information, please see the .NET [README] [dotnet-readme].
207+
For more information, please see the .NET [README][dotnet-readme].
208208

209209
## Usage: PHP
210210

@@ -226,7 +226,7 @@ if ($referer->isKnown()) {
226226
}
227227
```
228228

229-
For more information, please see the PHP [README] [php-readme].
229+
For more information, please see the PHP [README][php-readme].
230230

231231
## Usage: Go
232232

@@ -255,11 +255,11 @@ func main() {
255255

256256
```
257257

258-
For more information, please see the Go [README] [go-readme]
258+
For more information, please see the Go [README][go-readme]
259259

260260
## referers.yml
261261

262-
referer-parser identifies whether a URL is a known referer or not by checking it against the [`referers.yml`] [referers-yml] file; the intention is that this YAML file is reusable as-is by every language-specific implementation of referer-parser.
262+
referer-parser identifies whether a URL is a known referer or not by checking it against the [`referers.yml`][referers-yml] file; the intention is that this YAML file is reusable as-is by every language-specific implementation of referer-parser.
263263

264264
The file is broken out into sections for the different mediums that we support:
265265

@@ -291,31 +291,31 @@ We welcome contributions to referer-parser:
291291
2. **Ports of referer-parser to other languages** - we welcome ports of referer-parser to new programming languages (e.g. Lua, Go, Haskell, C)
292292
3. **Bug fixes, feature requests etc** - much appreciated!
293293

294-
**Please sign the [Snowplow CLA] [cla] before making pull requests.**
294+
**Please sign the [Snowplow CLA][cla] before making pull requests.**
295295

296296
## Support
297297

298298
General support for referer-parser is handled by the team at Snowplow Analytics Ltd.
299299

300-
You can contact the Snowplow Analytics team through any of the [channels listed on their wiki] [talk-to-us].
300+
You can contact the Snowplow Analytics team through any of the [channels listed on their wiki][talk-to-us].
301301

302302
## Copyright and license
303303

304-
`referers.yml` is based on [Piwik's] [piwik] [`SearchEngines.php`] [piwik-search-engines] and [`Socials.php`] [piwik-socials], copyright 2012 Matthieu Aubry and available under the [GNU General Public License v3] [gpl-license].
304+
`referers.yml` is based on [Piwik's][piwik] [`SearchEngines.php`][piwik-search-engines] and [`Socials.php`][piwik-socials], copyright 2012 Matthieu Aubry and available under the [GNU General Public License v3][gpl-license].
305305

306-
The Ruby implementation is copyright 2014 Inside Systems, Inc and is available under the [Apache License, Version 2.0] [apache-license].
306+
The Ruby implementation is copyright 2014 Inside Systems, Inc and is available under the [Apache License, Version 2.0][apache-license].
307307

308-
The Java/Scala port is copyright 2012-2014 [Snowplow Analytics Ltd] [snowplow-analytics] and is available under the [Apache License, Version 2.0] [apache-license].
308+
The Java/Scala port is copyright 2012-2014 [Snowplow Analytics Ltd][snowplow-analytics] and is available under the [Apache License, Version 2.0][apache-license].
309309

310-
The Python port is copyright 2012-2014 [Don Spaulding] [donspaulding] and is available under the [Apache License, Version 2.0] [apache-license].
310+
The Python port is copyright 2012-2014 [Don Spaulding][donspaulding] and is available under the [Apache License, Version 2.0][apache-license].
311311

312-
The node.js (JavaScript) port is copyright 2013-2014 [Martin Katrenik] [mkatrenik] and is available under the [Apache License, Version 2.0] [apache-license].
312+
The node.js (JavaScript) port is copyright 2013-2014 [Martin Katrenik][mkatrenik] and is available under the [Apache License, Version 2.0][apache-license].
313313

314-
The .NET (C#) port is copyright 2013-2014 [iPerform Software] [iperform] and is available under the [Apache License, Version 2.0] [apache-license].
314+
The .NET (C#) port is copyright 2013-2014 [iPerform Software][iperform] and is available under the [Apache License, Version 2.0][apache-license].
315315

316-
The PHP port is copyright 2013-2014 [Lars Strojny] [lstrojny] and is available under the [MIT License] [mit-license].
316+
The PHP port is copyright 2013-2014 [Lars Strojny][lstrojny] and is available under the [MIT License][mit-license].
317317

318-
The Go port is copyright 2014 [Thomas Sileo] [tsileo] and is available under the [MIT License] [mit-license].
318+
The Go port is copyright 2014 [Thomas Sileo][tsileo] and is available under the [MIT License][mit-license].
319319

320320
[ua-parser]: https://github.com/tobie/ua-parser
321321

dotnet/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# referer-parser .NET library
22

3-
This is the .NET implementation of [referer-parser] [referer-parser], the library for extracting attribution data from referer _(sic)_ URLs.
3+
This is the .NET implementation of [referer-parser][referer-parser], the library for extracting attribution data from referer _(sic)_ URLs.
44

5-
The implementation uses the shared 'database' of known referers found in [`referers.yml`] [referers-yml].
5+
The implementation uses the shared 'database' of known referers found in [`referers.yml`][referers-yml].
66

7-
The .NET version of referer-parser is maintained by [Sepp Wijnands] [swijnands] at [iPerform Software] [iperform].
7+
The .NET version of referer-parser is maintained by [Sepp Wijnands][swijnands] at [iPerform Software][iperform].
88

99
## C\#
1010

@@ -41,9 +41,9 @@ A NuGet Package is available, under package id RefererParser.
4141

4242
## Copyright and license
4343

44-
The referer-parser .NET (C#) library is copyright 2013 [iPerform Software] [iperform].
44+
The referer-parser .NET (C#) library is copyright 2013 [iPerform Software][iperform].
4545

46-
Licensed under the [Apache License, Version 2.0] [license] (the "License");
46+
Licensed under the [Apache License, Version 2.0][license] (the "License");
4747
you may not use this software except in compliance with the License.
4848

4949
Unless required by applicable law or agreed to in writing, software

go/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# referer-parser Go library
22

3-
This is the Go implementation of [referer-parser] [referer-parser], the library for extracting search marketing data from referer _(sic)_ URLs.
3+
This is the Go implementation of [referer-parser][referer-parser], the library for extracting search marketing data from referer _(sic)_ URLs.
44

5-
The implementation uses the shared 'database' of known referers found in [`referers.yml`] [referers-yml].
5+
The implementation uses the shared 'database' of known referers found in [`referers.yml`][referers-yml].
66

7-
The Go version of referer-parser is maintained by [Thomas Sileo] [tsileo].
7+
The Go version of referer-parser is maintained by [Thomas Sileo][tsileo].
88

99
## Installation
1010

@@ -39,7 +39,7 @@ func main() {
3939

4040
## referers.yml embed
4141

42-
The [`referers.json`] [referers-yml] is embedded in the package using [`go-bindata`] [go-bindata].
42+
The [`referers.json`][referers-yml] is embedded in the package using [`go-bindata`][go-bindata].
4343

4444
```
4545
$ go-bindata -ignore=\\.yml -pkg refererparser data/...

java-scala/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# referer-parser Java/Scala library
22

3-
This is the Java and Scala implementation of [referer-parser] [referer-parser], the library for extracting attribution data from referer _(sic)_ URLs.
3+
This is the Java and Scala implementation of [referer-parser][referer-parser], the library for extracting attribution data from referer _(sic)_ URLs.
44

5-
The implementation uses the shared 'database' of known referers found in [`referers.yml`] [referers-yml].
5+
The implementation uses the shared 'database' of known referers found in [`referers.yml`][referers-yml].
66

7-
The Scala implementation is a core component of [Snowplow] [snowplow], the open-source web-scale analytics platform powered by Hadoop, Hive and Redshift.
7+
The Scala implementation is a core component of [Snowplow][snowplow], the open-source web-scale analytics platform powered by Hadoop, Hive and Redshift.
88

99
## Java
1010

@@ -133,7 +133,7 @@ val refererParser = "com.snowplowanalytics" %% "referer-parser" % "0.3.0"
133133

134134
The referer-parser Java/Scala library is copyright 2012-2015 Snowplow Analytics Ltd.
135135

136-
Licensed under the [Apache License, Version 2.0] [license] (the "License");
136+
Licensed under the [Apache License, Version 2.0][license] (the "License");
137137
you may not use this software except in compliance with the License.
138138

139139
Unless required by applicable law or agreed to in writing, software

nodejs/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# referer-parser node.js (JavaScript) library
22

3-
This is the node.js (JavaScript) implementation of [referer-parser] [referer-parser], the library for extracting search marketing data from referer _(sic)_ URLs.
3+
This is the node.js (JavaScript) implementation of [referer-parser][referer-parser], the library for extracting search marketing data from referer _(sic)_ URLs.
44

5-
The implementation uses the shared 'database' of known referers found in [`referers.yml`] [referers-yml]
5+
The implementation uses the shared 'database' of known referers found in [`referers.yml`][referers-yml]
66

7-
The Javascript version of referer-parser is maintained by [Martin Katrenik] [mkatrenik].
7+
The Javascript version of referer-parser is maintained by [Martin Katrenik][mkatrenik].
88

99
## Installation
1010

@@ -59,7 +59,7 @@ console.log(r.uri) // result of require('url').parse(...)
5959

6060
The referer-parser node.js (JavaScript) library is copyright 2013 Martin Katrenik.
6161

62-
Licensed under the [Apache License, Version 2.0] [license] (the "License");
62+
Licensed under the [Apache License, Version 2.0][license] (the "License");
6363
you may not use this software except in compliance with the License.
6464

6565
Unless required by applicable law or agreed to in writing, software

php/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# referer-parser PHP library
22

3-
This is the PHP implementation of [referer-parser] [referer-parser], the library for extracting search marketing data from referer _(sic)_ URLs.
3+
This is the PHP implementation of [referer-parser][referer-parser], the library for extracting search marketing data from referer _(sic)_ URLs.
44

5-
The implementation uses the shared 'database' of known referers found in [`referers.yml`] [referers-yml].
5+
The implementation uses the shared 'database' of known referers found in [`referers.yml`][referers-yml].
66

7-
The PHP version of referer-parser is maintained by [Lars Strojny] [lstrojny].
7+
The PHP version of referer-parser is maintained by [Lars Strojny][lstrojny].
88

99
## Installation
1010

python/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# referer-parser Python library
22

3-
This is the Python implementation of [referer-parser] [referer-parser], the library for extracting search marketing data from referer _(sic)_ URLs.
3+
This is the Python implementation of [referer-parser][referer-parser], the library for extracting search marketing data from referer _(sic)_ URLs.
44

5-
The implementation uses the shared 'database' of known referers found in [`referers.yml`] [referers-yml].
5+
The implementation uses the shared 'database' of known referers found in [`referers.yml`][referers-yml].
66

7-
The Python version of referer-parser is maintained by [Don Spaulding] [donspaulding].
7+
The Python version of referer-parser is maintained by [Don Spaulding][donspaulding].
88

99
## Installation
1010

@@ -82,7 +82,7 @@ The distribution process for Python looks like this:
8282

8383
The referer-parser Python library is copyright 2012-2016 Don Spaulding.
8484

85-
Licensed under the [Apache License, Version 2.0] [license] (the "License");
85+
Licensed under the [Apache License, Version 2.0][license] (the "License");
8686
you may not use this software except in compliance with the License.
8787

8888
Unless required by applicable law or agreed to in writing, software

ruby/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# referer-parser Ruby library
22

3-
This is the Ruby implementation of [referer-parser] [referer-parser], the library for extracting search marketing data from referer _(sic)_ URLs.
3+
This is the Ruby implementation of [referer-parser][referer-parser], the library for extracting search marketing data from referer _(sic)_ URLs.
44

5-
The implementation uses the shared 'database' of known referers found in [`referers.yml`] [referers-yml].
5+
The implementation uses the shared 'database' of known referers found in [`referers.yml`][referers-yml].
66

77
## Installation
88

@@ -83,7 +83,7 @@ parser.parse('http://www.google.com/search?q=gateway+oracle+cards+denise+linn&hl
8383

8484
The referer-parser Ruby library is copyright 2014 Inside Systems, Inc.
8585

86-
Licensed under the [Apache License, Version 2.0] [license] (the "License");
86+
Licensed under the [Apache License, Version 2.0][license] (the "License");
8787
you may not use this software except in compliance with the License.
8888

8989
Unless required by applicable law or agreed to in writing, software

0 commit comments

Comments
 (0)