Update crate info

This commit is contained in:
Remco Bloemen 2022-02-01 12:17:05 -08:00
parent 46c340a049
commit cc09d79f51
3 changed files with 24 additions and 38 deletions

View File

@ -1,9 +1,19 @@
[package]
name = "libsemaphore-rs"
name = "semaphore"
version = "0.1.0"
edition = "2021"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
authors = [
"Remco Bloemen <remco@worldcoin.org>",
"Philipp Sippl <philipp@worldcoin.org>"]
edition = "2021"
build = "build.rs"
homepage = "https://github.com/worldcoin/semaphore-rs"
repository = "https://github.com/worldcoin/semaphore-rs"
description = "Rust support library for Semaphore"
keywords = ["worldcoin", "protocol", "signup"]
categories = ["cryptography"]
readme = "Readme.md"
license-file = "mit-license.md"
[lib]
name = "semaphore"

View File

@ -1,36 +1,3 @@
# README
# Semaphore-rs
## Native ios library
### Setup build environnement
See the [instructions from Mozilla](https://mozilla.github.io/firefox-browser-architecture/experiments/2017-09-06-rust-on-ios.html).
We will focus only on `aarch64` and skip the multi-arch. This means an iPhone 5S or later is required.
```shell
xcode-select --install
rustup target add aarch64-apple-ios
xcrun --show-sdk-path --sdk iphoneos
```
If you get the error `xcrun: error: SDK "iphoneos" cannot be located`, run `sudo xcode-select --switch /Applications/Xcode.app`. See [here](https://www.ryadel.com/en/xcode-sdk-iphoneos-cannot-be-located-mac-osx-error-fix/).
### Build library
```shell
cargo build --release --lib --target aarch64-apple-ios
```
```shell
ls -lah ./target/aarch64-apple-ios/release
```
### Check bloatiness
We can not check the static library directly. Instead we will compile a minimal executable that uses it and check that.
```shell
cargo bloat --release --target aarch64-apple-ios --crates -n 30
```
Rust support library for Semaphore

9
mit-license.md Normal file
View File

@ -0,0 +1,9 @@
# The MIT License (MIT)
Copyright © 2021 Worldcoin
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
**The Software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the Software or the use or other dealings in the Software.**