Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add FAQ and Privacy Policy placeholders #160

Merged
merged 7 commits into from
Sep 21, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
.pub-cache/
.pub/
/build/
.pubspec.lock

# Web related
lib/generated_plugin_registrant.dart
Expand Down
7 changes: 7 additions & 0 deletions FAQ.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# FAQ

in progress

## CONTACT

in progress
3 changes: 3 additions & 0 deletions PRIVACY-POLICY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# PRIVACY POLICY

in progress
53 changes: 3 additions & 50 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Cross-platform Magic Wormhole graphical client
# Destiny - Cross-platform Magic Wormhole graphical client

⚠ This project is still a work in progress, use at your own risk ⚠

Expand All @@ -11,9 +11,10 @@ with a Dart API. The plugin is implemented [here](https://github.com/LeastAuthor
Supported platforms

- [x] Linux
- [x] Android
- [x] Windows
- [x] OSX
- [x] Android
- [ ] iOS

## Cloning

Expand Down Expand Up @@ -52,54 +53,6 @@ Builds for local instances:
flutter build linux lib/main_local.dart
```

## Signing Android AppBundle for Google Play upload
Improtant! First time upload key is used for signing further builds. Key should be shared with other developers if more then one person is signing app

Developer upload key is necessary for upload AppBundle to store. Find out [more](https://support.google.com/googleplay/android-developer/answer/9842756?hl=en#zippy=%2Cupload-key-requirements)
1. Generate upload key with keytool (Note! store keystore.jks file outside project dir)
```bash
keytool -genkey -v -keystore ~/upload-keystore.jks -keyalg RSA -keysize 2048 -validity 10000 -alias upload-key
```
2. Create key.properties file and add your details (Note! key.properties should outside project dir and not be pushed to repo)
```bash
KEY_ALIAS=upload-key
KEY_PASSWORD=<password>
STORE_FILE=/Users/<my_user>/upload-keystore.jks
STORE_PASSWORDP=<password>
```
3. Set key.properties path in gradle.properties file for parameter AndroidProject.signing=/your/path/key.properties
4. Run build manually
```bash
flutter build appbundle --build-name=<build_version> --dart-define version=<build_version> --build-number=<build_number> -t lib/main_la.dart
```
Note: Google Play store requires unique or incremental build-number for every upload to store.

## Usage with `wormhole-william`

Send a file:

```bash
wormhole-william send <file_path>
```

Receive a file:

```bash
wormhole-william receive 33-leprosy-highchair
```

Transferring files with leastauthority.com

```bash
wormhole-william receive --relay-url="wss://mailbox.w.leastauthority.com/v1" --transit-helper="wss://relay.w.leastauthority.com:443" 33-leprosy-highchair
```

Transferring files with a local backend

```bash
wormhole-william receive --relay-url="ws://0.0.0.0:4000/v1" --transit-helper="tcp:0.0.0.0:4001" 33-leprosy-highchair
```

### Starting the wormhole services locally

```bash
Expand Down
4 changes: 4 additions & 0 deletions TERMS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# TERMS & CONDITIONS

in progress

23 changes: 23 additions & 0 deletions doc/releases.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,28 @@
# Signing releases and verification

## Android AppBundle for Google Play upload
Improtant! First time upload key is used for signing further builds. Key should be shared with other developers if more then one person is signing app

Developer upload key is necessary for upload AppBundle to store. Find out [more](https://support.google.com/googleplay/android-developer/answer/9842756?hl=en#zippy=%2Cupload-key-requirements)
1. Generate upload key with keytool (Note! store keystore.jks file outside project dir)
```bash
keytool -genkey -v -keystore ~/upload-keystore.jks -keyalg RSA -keysize 2048 -validity 10000 -alias upload-key
```
2. Create key.properties file and add your details (Note! key.properties should outside project dir and not be pushed to repo)
```bash
KEY_ALIAS=upload-key
KEY_PASSWORD=<password>
STORE_FILE=/Users/<my_user>/upload-keystore.jks
STORE_PASSWORDP=<password>
```
3. Set key.properties path in gradle.properties file for parameter AndroidProject.signing=/your/path/key.properties
4. Run build manually
```bash
flutter build appbundle --build-name=<build_version> --dart-define version=<build_version> --build-number=<build_number> -t lib/main_la.dart
```
Note: Google Play store requires unique or incremental build-number for every upload to store.


## MacOS

In order to build signed macos releases, a valid code signing certificate needs to be added to the key chain.
Expand Down