Skip to content

Commit 127142a

Browse files
committed
Add 📈 emoji
1 parent 7a67a95 commit 127142a

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

README.md

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

33
Public analytics as a Node.js microservice, no sysadmin experience required.
44

@@ -13,14 +13,12 @@ A tiny analytics server with less than 100 lines of code, easy to run and hack a
1313
Running your own `micro-analytics` is just two tiny commands away:
1414

1515
```
16-
1716
npm install -g micro-analytics-cli
1817
1918
micro-analytics
20-
2119
```
2220

23-
That's it, The analytics server is now running at `localhost:3000`! 🎉
21+
That's it, the analytics server is now running at `localhost:3000`! 🎉
2422

2523
See [`server-setup.md`](./server-setup.md) for instructions on acquiring a server and setting up `nginx` to make your `micro-analytics` publicly available.
2624

@@ -30,7 +28,7 @@ See [`server-setup.md`](./server-setup.md) for instructions on acquiring a serve
3028

3129
### Tracking views
3230

33-
To track a view, simply send a request to `/<id>`. If you send a `GET` request, the request will increment the views and return the total views for that id. If you send a `POST` request, the views will increment but you don't get the total views back.
31+
To track a view of `x`, simply send a request to `/x`. If you send a `GET` request, the request will increment the views and return the total views for the id. (in this case "x") If you send a `POST` request, the views will increment but you don't get the total views back.
3432

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

@@ -44,7 +42,7 @@ This is how you'd track pageviews for a website: (though note that this can be u
4442
</script>
4543
```
4644

47-
If you just want to get the views for an id and don't want to increment the views during a `GET` request, set `inc` to `false` in your query parameter. (`/<id>?inc=false`)
45+
If you just want to get the views for an id and don't want to increment the views during a `GET` request, set `inc` to `false` in your query parameter. (`/x?inc=false`)
4846

4947
If you want to get all views for all ids, set the `all` query parameter to `true`. (`/?all=true`)
5048

0 commit comments

Comments
 (0)