lesbian.skin
Image sharing backed by ATProto
atproto
images
gleam
update README
Signed-off-by: Naomi Roberts <mia@naomieow.xyz>
+20
-20
+20
-20
README.md
+20
-20
README.md
···
1
1
# plonk
2
2
3
-
[](https://hex.pm/packages/plonk)
4
-
[](https://hexdocs.pm/plonk/)
5
-
6
-
```sh
7
-
gleam add plonk@1
8
-
```
9
-
```gleam
10
-
import plonk
11
-
12
-
pub fn main() -> Nil {
13
-
// TODO: An example of the project in use
14
-
}
15
-
```
16
-
17
-
Further documentation can be found at <https://hexdocs.pm/plonk>.
3
+
## ⚠️ WIP ⚠️ - Still in development
18
4
19
-
## Development
5
+
Plonk is an image sharing and hosting app, akin to something like Imgur. Where
6
+
Plonk differs from those apps is how the images are stored - they are stored on
7
+
the AT Protocol. What this means for you, the user, is that even if Plonk gets
8
+
blocked by a country, ISP or similar, your images and data are still available
9
+
to you, as none of it is stored on Plonk's servers (Plonk doesn't even have
10
+
servers!).
20
11
21
-
```sh
22
-
gleam run # Run the project
23
-
gleam test # Run the tests
24
-
```
12
+
## Roadmap
13
+
- [ ] In-app viewing
14
+
- [ ] Image titles/descriptions
15
+
- [ ] Formal Lexicon definitions
16
+
- [ ] Pre-upload previews
17
+
- [ ] Image collections
18
+
- [ ] Bulk uploading
19
+
- [ ] Option to choose whether to make a collection
20
+
- [ ] Self-hosting documentation
21
+
- [ ] Nix module?
22
+
- [ ] Docker image?
23
+
- [ ] Video support?
24
+
- [ ] Generic file support?