Fix readme.

diff --git a/.gitignore b/.gitignore
new file mode 100644 (file)
index 0000000..d64f827
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,3 @@
+.idea
+/res
+/target

diff --git a/README.md b/README.md
index 1df2902dbac91c2174657b5df2eb34651aad005b..e38376293616e496500d0b7c557abd2cb240f900 100644 (file)
--- a/README.md
+++ b/README.md
@@ -5,7 +5,9 @@ gossip data.
 
 These are the components it's comprised of.
 
-## config
+## Modules
+
+### config
 
 A config file where the Postgres credentials and Lightning peers can be adjusted. Most adjustments
 can be made by setting environment variables, whose usage is as follows:
@@ -23,27 +25,14 @@ can be made by setting environment variables, whose usage is as follows:
 Notably, one property needs to be modified in code, namely the `ln_peers()` method. It specifies how
 many and which peers to use for retrieving gossip.
 
-## download
+### downloader
 
 The module responsible for initiating the scraping of the network graph from its peers.
 
-## persistence
+### persistence
 
 The module responsible for persisting all the downloaded graph data to Postgres.
 
-## server
-
-The server is responsible for returning dynamic and snapshotted rapid sync data.
-
-Dynamic sync data is fed a timestamp of the last sync, and it dynamically calculates a delta
-such that a minimal change set is returned based on changes which are assumed to have been seen
-by the client (ignoring any intermediate changes). Dynamic sync is only available after the first
-full graph sync completes on startup.
-
-Snapshot sync data is also based on a timestamp, but unlike dynamic sync, its responses are
-precalculated, which is done in a way that considers the possibility that the client may have
-intermittently seen later updates.
-
 ### snapshot
 
 The snapshotting module is responsible for calculating and storing snapshots. It's started up
@@ -67,22 +56,6 @@ announcement.
 Finally, all channel update transitions are evaluated and collected into either a full or an
 incremental update.
 
-## Making a call
-
-### Dynamic
-
-Make a call to
-
-`http://localhost:3030/dynamic/1652644698`
-
-Where `1652644698` is the last sync timestamp.
-
-### Snapshotted
-
-Same as above, but sub `dynamic` for `snapshot`:
-
-`http://localhost:3030/snapshot/1652644698`
-
 ## License
 
-MIT
+[Apache 2.0](LICENSE-APACHE) or [MIT](LICENSE-MIT), at your option.