Skip to content

Commit

Permalink
Update README.md to include iOS
Browse files Browse the repository at this point in the history
Added build-ios to Makefile
Added age.aar to example android project
  • Loading branch information
MarinX committed Jun 21, 2022
1 parent 8ae628a commit 1fef994
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 7 deletions.
5 changes: 3 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,6 @@
# vendor/

# Output of gomobile
age.aar
age-sources.jar
build/android/age-sources.jar
build/android/age.aar
build/ios/Age.xcframework
5 changes: 4 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,7 @@ test:
go test -race -v

build-android:
gomobile bind -target android -o age.aar filippo.io/age github.com/MarinX/agemobile
gomobile bind -target android -o build/android/age.aar filippo.io/age github.com/MarinX/agemobile

build-ios:
gomobile bind -target ios -o build/ios/Age.xcframework filippo.io/age github.com/MarinX/agemobile
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ This package wraps age library into usable mobile library.

### Android

1. Get `age.aar` (You can get `age.aar` from [release page](https://github.com/MarinX/agemobile/releases) or clone the repo and execute `make build-android` to build .aar yourself)
2. Create `libs` folder in your app project android app and copy `age.aar`
1. Get `age.aar` (You can get `age.aar` from [release page](https://github.com/MarinX/agemobile/releases) or clone the repo and execute `make build-android` to build .aar yourself - Build artifact is located in `build/android` folder.)
2. Add `age.aar` to `libs` folder in your app project
3. Include dependency for Android in `build.gradle`

```gradle
Expand All @@ -24,7 +24,9 @@ dependencies {

### iOS

No documentation, PR's welcome
1. Get `Age.xcframework` (You can get `Age.xcframework` from [release page](https://github.com/MarinX/agemobile/releases) or clone the repo and execute `make build-ios` to build yourself - Build artifact is located in `build/ios` folder.)
2. Copy `Age.xcframework` into iOS project framework folder
3. Import `Age` in Swift

## Usage

Expand Down Expand Up @@ -92,7 +94,7 @@ No examples, yet! PR's welcome.

## Contributing

PR's are welcome. Please read [CONTRIBUTING.md](https://github.com/MarinX/agemobile/blob/master/CONTRIBUTING.md) for more info
PR's are welcome. Please read [CONTRIBUTING.md](https://github.com/MarinX/agemobile/blob/main/CONTRIBUTING.md) for more info

## License

Expand Down
Binary file added _examples/android/AgeMobile/app/libs/age.aar
Binary file not shown.

0 comments on commit 1fef994

Please sign in to comment.