Skip to content

Commit 209710a

Browse files
committed
improve documentation
1 parent 91fed75 commit 209710a

2 files changed

Lines changed: 14 additions & 9 deletions

File tree

README.md

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

3-
Public analytics as a Node.js microservice.
3+
Public analytics as a Node.js microservice, no sysadmin experience required.
44

5-
With less than 100 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.
5+
A tiny analytics server with less than 100 lines of code, easy to run and hack around on. It does one thing, and it does it well: count the views of something and making the views publicly accessible via an API.
66

7-
(there is currently no frontend to display pretty graphs, feel free to build one!)
8-
9-
## Built with
10-
11-
- [`micro`](https://github.com/zeit/micro) to create the service.
12-
- [`flat-file-db`](https://github.com/mafintosh/flat-file-db) to store the data. (and [`promise`](https://github.com/then/promise) to promisify `flat-file-db`)
7+
(there is currently no frontend to display pretty graphs, feel free to build one yourself!)
138

149
## Setup
1510

@@ -45,6 +40,16 @@ If you want to get all views for all paths, set the `all` query parameter to `tr
4540

4641
If you run `npm run dev` the server will restart every time you edit the code. Perfect for development of `micro-analytics`!
4742

43+
## Built with
44+
45+
- [`micro`](https://github.com/zeit/micro) to create the service.
46+
47+
`micro` is a lightweight wrapper around Nodes `http.Server` which makes it easy to write ultra-high performance, asynchronous microservices. Perfect for our use case!
48+
49+
- [`flat-file-db`](https://github.com/mafintosh/flat-file-db) to store the data. (and [`promise`](https://github.com/then/promise) to promisify `flat-file-db`)
50+
51+
`flat-file-db` is a fast in-process flat file database that caches all data in memory and persists it to an open file using an append-only algorithm ensuring compact file sizes and strong consistency. By using the filesystem for storage setup is easy and backups are only a copy & paste away. (in case you need more advanced features of a real database, swapping out `flat-file-db` for a real db shouldn't take long)
52+
4853
## License
4954

5055
Copyright ©️ 2016 Maximilian Stoiber, licensed under the MIT License.

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": "Public analytics as a Node.js microservice.",
4+
"description": "Public analytics as a Node.js microservice, no sysadmin experience required.",
55
"main": "index.js",
66
"scripts": {
77
"start": "micro src/index.js",

0 commit comments

Comments
 (0)