Skip to content

Commit 81fbf68

Browse files
committed
Documentation: add new section about hosted database (close #150)
1 parent 57d9946 commit 81fbf68

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,26 @@
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 multi-language library 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).
6+
7+
The referer-parser project also contains multiple libraries for working with the referer-parser database in different languages.
68

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

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

13+
## Database
14+
15+
The latest database is always available on this URL:
16+
17+
https://s3-eu-west-1.amazonaws.com/snowplow-hosted-assets/third-party/referer-parser/referers-latest.yml
18+
19+
The database is updated at most once a month. Each new version of the database is also uploaded with a timestamp:
20+
21+
https://s3-eu-west-1.amazonaws.com/snowplow-hosted-assets/third-party/referer-parser/referers-YYYY-MM.yml
22+
23+
If there is an issue with the database necessitating a re-release within the month, the corresponding files will be overwritten.
24+
1125
## Maintainers
1226

1327
* Java/Scala: [Snowplow Analytics Ltd] [snowplow-analytics]

0 commit comments

Comments
 (0)