status-im
/
status-go
mirror of https://github.com/status-im/status-go.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Added basic history of the protocol package (#1984) 

'm trying to add more documentation to parts of the repo that I go into.

I feel this basic history will make it easier to understand why the protocol package is as big as it is compared to the other packages in the repo, and help in understanding its existence.
This commit is contained in:
Samuel Hawksby-Robinson 2020-06-04 11:23:09 +01:00 committed by GitHub
parent 1e3801d105
commit 88f4f75ae1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
protocol/README.md
View File

@ -16,3 +16,7 @@ The payloads are encoded using [protocol-buffers](https://developers.google.com/
* `applicationmetadata/` is an outer layer wrapping a payload with an app-specific metadata like a signature. * `applicationmetadata/` is an outer layer wrapping a payload with an app-specific metadata like a signature.
* `identity/` implements details related to creating a three-word name and identicon. * `identity/` implements details related to creating a three-word name and identicon.
* `migrations/` contains implementation specific migrations for the sqlite database which is used by `Messenger` as a persistent data store. * `migrations/` contains implementation specific migrations for the sqlite database which is used by `Messenger` as a persistent data store.
## History
Originally this package was a dedicated repo called `status-protocol-go` and [was migrated](https://github.com/status-im/status-go/pull/1684) into `status-go`. The new `status-go/protocol` package maintained its own dependencies until [sub modules were removed](https://github.com/status-im/status-go/pull/1835/files) and the root go.mod file managed all dependencies for the entire `status-go` repo.