Skip to content

Commit 8d9c5ee

Browse files
committed
Update repo base structure warning in the docs
1 parent b24ecba commit 8d9c5ee

2 files changed

Lines changed: 5 additions & 20 deletions

File tree

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
pubspec.lock
1414
venv/
1515
site/
16+
.vscode/
1617

1718
# IntelliJ related
1819
*.iml
@@ -53,4 +54,4 @@ app.*.map.json
5354
# Android Studio will place build artifacts here
5455
/android/app/debug
5556
/android/app/profile
56-
/android/app/release
57+
/android/app/release

README.md

Lines changed: 3 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,11 @@ See the website for [documentation](https://alexrintt.github.io/shared-storage).
2626

2727
All documentation is also available under `/docs` to each released version which is the data source of the website.
2828

29-
You can contribute to the documentation by just editing these files through the GitHub web editor!
29+
You can contribute to the documentation by just editing these files.
3030

3131
To check all ways you can contribute to this package see [Contributing/Ways to contribute](https://alexrintt.github.io/shared-storage/Contributing/Ways%20to%20contribute/).
3232

33-
Latest changes are available on `master` branch and the actual latest published package version lives under `release` branch.
33+
**To start developing, use `release` branch as base**, `master` is used for experimentation only and is likely to be not working.
3434

3535
All other branches are derivated from issues, new features or bug fixes.
3636

@@ -40,6 +40,7 @@ All other branches are derivated from issues, new features or bug fixes.
4040

4141
## Contributors
4242

43+
- [Tamerlanchiques](https://github.com/Tamerlanchiques) thanks a lot for the thoughtful bug reports.
4344
- [limshengli](https://github.com/limshengli) updated Android Gradle build version and Kotlin version on pull https://github.com/alexrintt/shared-storage/pull/115, thanks!
4445
- [honjow](https://github.com/honjow) contributed by [implementing `openDocument` Android API #110](https://github.com/alexrintt/shared-storage/pull/110) to pick single or multiple file URIs. Really helpful, thanks!
4546
- [clragon](https://github.com/clragon) submitted a severe [bug report #107](https://github.com/alexrintt/shared-storage/issues/107) and opened [discussions around package architecture #108](https://github.com/alexrintt/shared-storage/discussions/108), thanks!
@@ -49,20 +50,3 @@ All other branches are derivated from issues, new features or bug fixes.
4950
- [dangilbert](https://github.com/dangilbert) pointed and [fixed a bug #14](https://github.com/alexrintt/shared-storage/pull/14) when the user doesn't select a folder, thanks man!
5051
- A huge thanks to [aplicatii-romanesti](https://www.bibliotecaortodoxa.ro/) for taking time to submit [device specific issues](https://github.com/alexrintt/shared-storage/issues?q=author%3Aaplicatii-romanesti)!
5152
- I would thanks [ankitparmar007](https://github.com/ankitparmar007) for [discussing and requesting create file related APIs #20](https://github.com/alexrintt/shared-storage/issues/10)!
52-
53-
<br>
54-
55-
<samp>
56-
57-
<h2 align="center">
58-
Open Source
59-
</h2>
60-
<p align="center">
61-
<sub>Copyright © 2021-present, Alex Rintt.</sub>
62-
</p>
63-
<p align="center">Shared Storage <a href="https://github.com/alexrintt/shared-storage/blob/master/LICENSE.md">is MIT licensed 💖</a></p>
64-
<p align="center">
65-
<img src="https://user-images.githubusercontent.com/51419598/161439601-fc228a0d-d09d-4dbb-b5a3-ebc5dbcf9f46.png" width="35" />
66-
</p>
67-
68-
</samp>

0 commit comments

Comments
 (0)