diff --git a/.all-contributorsrc b/.all-contributorsrc index 58f3c8e..9063a74 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -105,6 +105,15 @@ "contributions": [ "code" ] + }, + { + "login": "omahs", + "name": "omahs", + "avatar_url": "https://avatars.githubusercontent.com/u/73983677?v=4", + "profile": "https://github.com/omahs", + "contributions": [ + "doc" + ] } ], "contributorsPerLine": 7, diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 61ce984..19ed646 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ -[![All Contributors](https://img.shields.io/badge/all_contributors-10-orange.svg?style=flat-square)](#contributors-) +[![All Contributors](https://img.shields.io/badge/all_contributors-11-orange.svg?style=flat-square)](#contributors-) diff --git a/README.md b/README.md index 728565b..5bf7a67 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,7 @@ We live on contributions. If you'd like to contribute please follow the [guide]( Mystic
Mystic
🎨 Mubarak Muhammad Aminu
Mubarak Muhammad Aminu
💻 Kishan Patel
Kishan Patel
💻 + omahs
omahs
📖 diff --git a/docs/src/getting-started/android-development.md b/docs/src/getting-started/android-development.md index f117d01..09a990a 100644 --- a/docs/src/getting-started/android-development.md +++ b/docs/src/getting-started/android-development.md @@ -1,8 +1,8 @@ # Android Development Crash Course -Because GrapheneOS (and thus Starknet Phone) is based on android, it is compatiable -with Android native applications. This will be a broad overview on how Android +Because GrapheneOS (and thus Starknet Phone) is based on android, it is compatible +with Android native applications. This will be a broad overview of how Android development is approached in this project. ## Environment/Android Studio setup diff --git a/docs/src/getting-started/building-the-os.md b/docs/src/getting-started/building-the-os.md index db245f0..29dfd45 100644 --- a/docs/src/getting-started/building-the-os.md +++ b/docs/src/getting-started/building-the-os.md @@ -21,7 +21,7 @@ echo 'export PATH=$PATH:/sbin:/usr/sbin:/usr/local/sbin' >> ~/.bashrc source ~/.bashrc ``` -More detailed dependiencies and build guide can be found +More detailed dependencies and build guide can be found [here](https://grapheneos.org/build) ## Downloading the source code diff --git a/docs/src/getting-started/rust-android-module.md b/docs/src/getting-started/rust-android-module.md index 673526f..a8d768b 100644 --- a/docs/src/getting-started/rust-android-module.md +++ b/docs/src/getting-started/rust-android-module.md @@ -16,7 +16,7 @@ for the build command [Documentaiont](https://developer.android.com/develop/background-work/services) -Main idea: servies are long-running operations in the background that can be accessed mby multiple devices. +Main idea: services are long-running operations in the background that can be accessed by multiple devices. This is what we want for the light client, and is how Ethereum Phone implements their light client. Must be declared in the manifest file: diff --git a/docs/src/getting-started/rust-in-android.md b/docs/src/getting-started/rust-in-android.md index 7440e6d..3e1c3ea 100644 --- a/docs/src/getting-started/rust-in-android.md +++ b/docs/src/getting-started/rust-in-android.md @@ -54,7 +54,7 @@ public class RustLib { ## Writing the rust side -We will writing rust code that compiles as C code to match the C header generated +We will write rust code that compiles as C code to match the C header generated when compiling the Java library created in the previous step. Use javac to compile the Java class into a C header. diff --git a/docs/src/overview/hardware-signing.md b/docs/src/overview/hardware-signing.md index 4542566..29248cf 100644 --- a/docs/src/overview/hardware-signing.md +++ b/docs/src/overview/hardware-signing.md @@ -11,12 +11,12 @@ extracted from the device via the secure keystore system. [Android Keystore Documentation](https://developer.android.com/privacy-and-security/keystore) Some notable features: -- Extraction prevention: key material cannot be extracted from the deivce in case of theft and +- Extraction prevention: key material cannot be extracted from the device in case of theft and cannot be accessed by application processes. - Hardware security module: similar to a Trusted Execution Environment (TEE), but specifically embedded Secure Elements (eSE) or on-SoC secure processing units (iSE) - Key use authorizations: specific authorizations can be set (and cannot be changed) to enforce - key usage to meet certain constraints such as specific algortithms or time intervals. + key usage to meet certain constraints such as specific algorithms or time intervals. ## The Starknet side