Skip to content

Commit

Permalink
update instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
MikePresman committed Dec 15, 2023
1 parent 4f16e68 commit f2ec6f2
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

Dateilager is a content-addressed, networked filesystem for keeping large, similar directories among a wide variety of hosts. It has a few key properties:

- file contents and versions are stored in by a central server, with readers and writers as clients
- files and trees of files are stored only once in a content-addressed store by the server for efficiency, but are still served securely to only clients with access
- readers and writers keep a copy of the filesystem synced locally for very fast local access (and trade off consistency or atomicity)
- incremental updates by readers are O(changes) and optimized to be very fast
- one Dateilager server supports storing many different independent filesystems with secured access to each (multi-tenancy)
- file contents and versions are stored in by a central server, with readers and writers as clients
- files and trees of files are stored only once in a content-addressed store by the server for efficiency, but are still served securely to only clients with access
- readers and writers keep a copy of the filesystem synced locally for very fast local access (and trade off consistency or atomicity)
- incremental updates by readers are O(changes) and optimized to be very fast
- one Dateilager server supports storing many different independent filesystems with secured access to each (multi-tenancy)

Dateilager is used in production to power https://gadget.dev to sync the filesystems for all the apps on the Gadget platform. Dateilager shines at syncing the (often very large) `node_modules` folder shared between the many node.js applications, as well as the comparatively small `.js` files comprising the actual business logic of one particular app.

Expand Down Expand Up @@ -153,12 +153,13 @@ console.log("[updateObject] version: " + version);

## Release

When you're ready to release a new version, perform the following steps:
When you're ready to release a new version, perform the following steps. Ensure you are on doing these steps on the `main` branch

1. Update the version in `default.nix`
2. Update the version in `js/package.json`
3. Update the version in `js/package-lock.json` (run `cd js && npm install`)
4. Commit the changes (e.g. `git commit -am "Bump version to 0.0.x"`)
5. Push the changes upstream to main (e.g. `git push origin HEAD`)

New versions are released and hosted on Github. (https://github.com/gadget-inc/dateilager/releases)

Expand Down

0 comments on commit f2ec6f2

Please sign in to comment.