Merge pull request #286 from cdnjs/sven/docs

some more docs

Author: xtuc

README.md

@@ -12,7 +12,11 @@ This repository contains various tools that we use to help with the process of m
 
 ## Tools
 
-- [checker](./cmd/checker)
+- [checker](./cmd/checker): tools for our CI
+- [git-sync](./cmd/git-sync): pushes new cdnjs updates to the GitHub repo
+- [process-version-host](./cmd/process-version-host): listens for new versions and spawns container with [process-version].
+- [process-version](./cmd/process-version): processes new versions (organizes files, compresses, minifies etc)
+- [r2-pump](./cmd/r2-pump): pushes new cdnjs updates to the Cloudflare R2
 
 ## Configuration
 

cmd/git-sync/README.md

@@ -0,0 +1,19 @@
+## Build
+
+Build git-sync:
+```
+cd ./cmd/git-sync
+go build
+```
+
+## Usage
+
+Write last update marker file (can be found at https://github.com/cdnjs/cdnjs/blob/master/last-sync):
+```
+echo "2024-09-08T01:33:46.508Z" > /tmp/last-sync
+```
+
+Run git-sync:
+```
+DEBUG=1 PUSH_FREQ=0 ./git-sync /tmp/last-sync cdnjs-outgoing-prod
+```