Skip to content

Commit 3d8f795

Browse files
committed
Update README
1 parent 77a3361 commit 3d8f795

File tree

1 file changed

+11
-12
lines changed

1 file changed

+11
-12
lines changed

README.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
[![Go Report Card](https://goreportcard.com/badge/github.com/creativecreature/pulse)](https://goreportcard.com/report/github.com/creativecreature/pulse)
66
[![Test](https://github.com/creativecreature/pulse/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/creativecreature/pulse/actions/workflows/main.yml)
77

8-
This repository contains all of the code for gathering the data which I display
9-
on my [website][1]
8+
This repository contains all of the code I use to gather data for my
9+
[website][1]
1010

1111
![Screenshot of website][2]
1212

@@ -23,21 +23,20 @@ procedure calls from the neovim plugin pertaining to events such as the opening
2323
of buffers, windows gaining focus, the initiation of new `nvim` processes, etc.
2424

2525
These calls contains the path to the buffer, which the server parses and writes
26-
to a log-structured key-value store. The store is a work in progress, but it
27-
now includes some core features such as hash indexes, segmentation, and
28-
compaction.
26+
to a log-structured append-only key-value store. The store is a work in
27+
progress, but it now includes some core features such as hash indexes,
28+
segmentation, and compaction.
2929

3030
The server runs a background job which requests all of the buffers from the KV
31-
store, and proceeds to aggregate them to a remote database. I chose this
32-
approach primarily because I wanted to avoid surpassing the limits set by the
33-
free tier for the MongoDB database.
31+
store, and proceeds to aggregate them to a remote database. I did it this way
32+
primarily because I wanted to avoid surpassing the limits set by the free tier
33+
for the remote database.
3434

3535
The only things that aren't included in this repository is the API which
3636
retrieves the data and the website that displays it. The website has been the
37-
most challenging part so far because I wanted it to have a unique look and feel
38-
and to build all of the components from scratch. I'm in the process of making
39-
it open source, but there are still a few things that I'd like to clean up
40-
first!
37+
most challenging part so far. I wanted it to have a unique look and feel and to
38+
build all of the components from scratch. I'm in the process of making it open
39+
source, but there are still a few things that I'd like to clean up first!
4140

4241
# Running this project
4342

0 commit comments

Comments
 (0)