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

Clarify situation between lib and mobile (#1909)

This commit is contained in:
Adam Babik 2020-03-24 11:22:55 +01:00 committed by GitHub
parent fd4c627c2e
commit 2169a27454
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
lib/README.md Normal file
View File

@ -0,0 +1,8 @@
lib
===
**DEPRECATED. Please see [`./mobile`](./mobile/REDME.md) instead. Currently, the exported bindings are not in sync with `mobile`. They might be missing or working differently.**
This package provides CGO bindings so that it can be used to create a static library and link it with other projects in different languages, namely [status-react](https://github.com/status-im/status-react). Even though, we switched to [gomobile](./mobile/REDME.md), this package can still be useful for generating a static library to link with C/C++ program.
Bindings are exported and described in `library.go`.

8
mobile/README.md
View File

@ -2,11 +2,15 @@
Package mobile implements [gomobile](https://github.com/golang/mobile) bindings for status-go. Current implementation servers as a drop-in replacement for `lib` package. Package mobile implements [gomobile](https://github.com/golang/mobile) bindings for status-go. Current implementation servers as a drop-in replacement for `lib` package.
Individual bindings and their descriptions are available in `status.go`.
The primary consumer of this package is [status-react project](https://github.com/status-im/status-react).
The framework name is generated from the package name, hence these things are done intentionally: The framework name is generated from the package name, hence these things are done intentionally:
(1) this package's name isn't equal to the directory name (`statusgo` vs `mobile` respectively); (1) this package's name isn't equal to the directory name (`statusgo` vs `mobile` respectively);
(2) this package name is `statusgo` and not `status` which produces the right framework name. (2) this package name is `statusgo` and not `status` which produces the right framework name.
# Usage ## Usage
For properly using this package, please refer to Makefile in the root of `status-go` directory. For properly using this package, please refer to Makefile in the root of `status-go` directory.
@ -26,6 +30,6 @@ gomobile bind -v -target=android -ldflags="-s -w" github.com/status-im/status-go
``` ```
This will generate `Statusgo.aar` file in the current dir. This will generate `Statusgo.aar` file in the current dir.
# Notes ## Notes
See [https://github.com/golang/go/wiki/Mobile](https://github.com/golang/go/wiki/Mobile) for more information on `gomobile` usage. See [https://github.com/golang/go/wiki/Mobile](https://github.com/golang/go/wiki/Mobile) for more information on `gomobile` usage.