Skip to content

Commit bf48eef

Browse files
committed
chore(documentation): readme update
1 parent 1fda263 commit bf48eef

File tree

2 files changed

+35
-19
lines changed

2 files changed

+35
-19
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ Thank you for your interest in contributing to AltSendme! Your help is appreciat
66

77
The best way to get started is to join our Discord and say hi. Introduce yourself and share what skills or interests you have - whether that’s coding, testing, design, or something else. You can also raise issues, suggest fixes, or pitch ideas. Maintainers are there to guide you every step of the way.
88

9+
10+
## Testing
11+
12+
Install [Sendme CLI](https://www.iroh.computer/sendme) tool and you can share files within same device to test the whole transfer process. Files don't leave your device just works like a copy operation.
13+
914
## How You Can Help
1015

1116
This project welcomes contributions in several key areas:

README.md

Lines changed: 30 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ A free and open-source file transfer tool that harnesses the power of [cutting-e
2929

3030
Why rely on WeTransfer, Dropbox, or Google Drive when you can reliably and easily transfer files directly, end-to-end encrypted and without revealing any personal information?
3131

32-
[Receive major project updates 📫](https://tally.so/r/ob2Vkx)
3332

3433
## Features
3534

@@ -42,7 +41,6 @@ Why rely on WeTransfer, Dropbox, or Google Drive when you can reliably and easil
4241
- **Fast & reliable** – Capable of saturating multi-gigabit connections for lightning-fast transfers.
4342
- [**NAT traversal via QUIC**](https://www.iroh.computer/docs/faq#does-iroh-use-relay-servers) – Secure, low-latency connections using QUIC hole punching with encrypted relay fallback.
4443
- **CLI integration** – Interoperable with the [Sendme CLI](https://www.iroh.computer/sendme).
45-
- **Mobile & web** – Coming soon.
4644
- **Free & open source** – No upload costs, no size limits, and fully community-driven.
4745

4846

@@ -80,6 +78,10 @@ scoop install extras/altsendme
8078
More download options in [GitHub Releases](https://github.com/tonyantony300/alt-sendme/releases).
8179

8280

81+
## Supported Languages
82+
🇺🇸 🇷🇺 🇫🇷 🇨🇳 🇩🇪 🇯🇵 🇮🇳 🇹🇭 🇮🇹 🇨🇿 🇪🇸 🇧🇷 🇸🇦 🇮🇷 🇰🇷 🇵🇱 🇺🇦 🇹🇷 🇳🇴 🇧🇩 🇭🇺 🇷🇸 🇹🇼
83+
84+
8385
## How it works
8486

8587
1. Drop your file or folder - AltSendme creates a one-time share code (called a "ticket").
@@ -139,20 +141,15 @@ AltSendme uses open-source public relay servers to support establishing direct c
139141

140142
## Roadmap 🚧
141143

142-
- Better support for Linux distros, Windows and mac.
143-
- Mobile versions
144-
- Faster transfers
145-
- Easier transfers
146-
- Better insights into transfer process and system/network info
147-
- Advanced user interface for power users and simple functional UI for those who just want to share stuff.
148-
- Features for those who needs better privacy
149-
- Features for those who wants speed and convenience
144+
- Improving usability for Linux distros, Windows and mac
145+
- Unthrottled, Reliable transfers with self-hosted relays
146+
- Better system/network insights into transfer process
147+
148+
149+
[📫 Drop your Email to recieve updates](https://tally.so/r/ob2Vkx)
150150

151-
[Receive updates 📫](https://tally.so/r/ob2Vkx)
152151

153152

154-
## Supported Languages
155-
🇺🇸 🇷🇺 🇷🇸 🇫🇷 🇨🇳 🇹🇼 🇩🇪 🇯🇵 🇹🇭 🇮🇹 🇨🇿 🇪🇸 🇧🇷 🇸🇦 🇮🇷 🇰🇷 🇮🇳 🇵🇱 🇺🇦 🇹🇷 🇳🇴 🇧🇩
156153

157154
## Troubleshooting
158155

@@ -216,25 +213,39 @@ AltSendme uses open-source public relay servers to support establishing direct c
216213
3. **Install Tauri**:
217214
```bash
218215
cargo install tauri-cli
216+
```
217+
218+
4. **Run in development mode**:
219+
```bash
220+
cargo tauri dev
221+
```
219222

220-
4. **(Optional) Setup android project**:
223+
5. **(Optional) Setup android project**:
221224
```bash
222225
rm src-tauri/gen/android
223226
cargo tauri android init
224227
git checkout src-tauri/gen/android
228+
cargo tauri android dev
225229
```
226230

227-
5. **Run in development mode**:
228-
```bash
229-
cargo tauri dev
230-
```
231231

232232
6. **Build locally** :
233233
```bash
234234
cargo tauri build --no-bundle
235235
```
236236

237-
## Join our [Discord](https://discord.gg/xwb7z22Eve)
237+
7. **Install on Android** :
238+
```
239+
npm run android:build -- --debug --apk
240+
241+
adb install -r src-tauri/gen/android/app/build/outputs/apk/universal/debug/app-universal-debug.apk
242+
```
243+
244+
## Testing Locally
245+
246+
Install [Sendme CLI](https://www.iroh.computer/sendme) tool and you can share files within same device to test the whole transfer process. Files don't leave your device just works like a copy operation.
247+
248+
## Join our [Discord](https://discord.gg/xwb7z22Eve) to contribute
238249

239250
The best way to contribute is to join our Discord and say hi. Introduce yourself and share what skills or interests you have - whether that’s coding, testing, design, or something else. You can also raise issues, suggest fixes, or pitch ideas. Maintainers are there to guide you every step of the way.
240251

0 commit comments

Comments
 (0)