Skip to content

Commit 634f4ee

Browse files
committed
chore(readme): local running instructions
1 parent 9ccb31d commit 634f4ee

2 files changed

Lines changed: 29 additions & 13 deletions

File tree

CONTRIBUTING.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
Thank you for your interest in contributing to AltSendme! Your help is appreciated in making file sharing frictionless, fast, and private for everyone.
44

5+
## Join our [Discord](https://discord.gg/xwb7z22Eve)
6+
7+
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.
8+
59
## How You Can Help
610

711
This project welcomes contributions in several key areas:
@@ -98,16 +102,21 @@ Feel free to reach out with questions, ideas, or just to say hello. Discussion a
98102
npm install
99103
```
100104

101-
3. **Run in development mode**:
105+
3. **Install Tauri**:
102106
```bash
103-
npm run app:dev
107+
cargo install tauri-cli
108+
109+
4. **Run in development mode**:
110+
```bash
111+
cargo tauri dev
104112
```
105113

106-
4. **Build for production** (optional):
114+
5. **Build locally** :
107115
```bash
108-
npm run app:build --no-bundle
116+
cargo tauri build --no-bundle
109117
```
110118

119+
111120
This will start the app with hot reload enabled for both frontend and backend changes.
112121

113122
### Before Submitting a Pull Request

README.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ 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-
[Drop your Email for receiving major project updates 📫](https://tally.so/r/ob2Vkx)
32+
[Receive major project updates 📫](https://tally.so/r/ob2Vkx)
3333

3434
## Features
3535

@@ -69,6 +69,13 @@ The easiest way to get started is by downloading one of the following versions f
6969
</tr>
7070
</table>
7171

72+
**Windows (Scoop)**
73+
74+
75+
```bash
76+
scoop bucket add extras
77+
scoop install extras/altsendme
78+
```
7279

7380
More download options in [GitHub Releases](https://github.com/tonyantony300/alt-sendme/releases).
7481

@@ -141,12 +148,7 @@ AltSendme uses open-source public relay servers to support establishing direct c
141148
- Features for those who needs better privacy
142149
- Features for those who wants speed and convenience
143150

144-
145-
## Contributing & Community ❤️
146-
147-
We’d love to meet you! Before diving into code or opening a PR, join our [Discord](https://discord.gg/xwb7z22Eve) to hang out, ask questions, and discuss ideas.
148-
149-
It’s the best place to get context, align on direction, and collaborate with the community.
151+
[Receive updates 📫](https://tally.so/r/ob2Vkx)
150152

151153

152154
## Supported Languages
@@ -220,11 +222,16 @@ It’s the best place to get context, align on direction, and collaborate with t
220222
cargo tauri dev
221223
```
222224

223-
5. **Build for production** (optional):
225+
5. **Build locally** :
224226
```bash
225-
cargo tauri build
227+
cargo tauri build --no-bundle
226228
```
227229

230+
## Join our [Discord](https://discord.gg/xwb7z22Eve)
231+
232+
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.
233+
234+
It’s the best place to get context, align on direction, and collaborate with the [community](https://discord.gg/xwb7z22Eve).
228235

229236
## License
230237

0 commit comments

Comments
 (0)