Skip to content

Commit 32579b9

Browse files
committed
Update README
1 parent 607a253 commit 32579b9

2 files changed

Lines changed: 5 additions & 5 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# `micro-analytics`
22

3-
Analytics as a simple Node.js microservice.
3+
Public analytics as a Node.js microservice.
44

5-
With less than 50 lines of code this service is the smallest analytics you'll ever need. It does nothing except count the views of a page on your site via an API.
5+
With less than 50 lines of code this service is the smallest analytics you'll ever need. It does nothing except count the views of something and making the views accessible via an API.
66

77
(there is currently no frontend to consume the statistics, though writing one is on the to-do list)
88

@@ -23,9 +23,9 @@ And that's it! 🎉 (see [`deployment.md`](./deployment.md) for deployment instr
2323

2424
### Tracking views
2525

26-
To track a view simply send a request to `/<yourpagepath>`. If you send a `GET` request, the request will increment the views and return the total views. If you send a `POST` request, the views will increment but you're not going to get the total views back.
26+
To track a view simply send a request to `/<yourpath>`. If you send a `GET` request, the request will increment the views and return the total views. If you send a `POST` request, the views will increment but you're not going to get the total views back.
2727

28-
If you don't want to increment the views during a `GET` request, set `inc` to `false` in your query parameter. (`/<yourpagepath>?inc=false`)
28+
If you don't want to increment the views during a `GET` request, set `inc` to `false` in your query parameter. (`/<yourpath>?inc=false`)
2929

3030
This is how you'd track pageviews for a website: (though note that this can be used to track anything you want)
3131

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "micro-analytics",
33
"version": "0.1.0",
4-
"description": "Analytics as a Node.js microservice.",
4+
"description": "Public analytics as a Node.js microservice.",
55
"main": "index.js",
66
"scripts": {
77
"start": "micro index.js",

0 commit comments

Comments
 (0)