diff options
Diffstat (limited to 'pkg/backend/README.md')
-rw-r--r-- | pkg/backend/README.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/pkg/backend/README.md b/pkg/backend/README.md new file mode 100644 index 0000000..1adefe8 --- /dev/null +++ b/pkg/backend/README.md @@ -0,0 +1,10 @@ +# how to add new fields to backend api + +1. add to the struct in `status.go` +2. populate it in `toJson()` method. +3. modify the `bitmask` interface in `pkg/bitmask/bitmask.go` (note: this is + a relict from the past, we can probably get rid of since there'll be + a single implementation in the foreseeable future). +4. modify the `bitmask` struct in `pkg/vpn/main.go` +5. modify the bitmask instantiation in `pkg/vpn/main.go:Init` +6. implement functionality... |