a tool for shared writing and social publishing
Update README.md to include publications
authored by
Brendan Schlagel
and committed by
GitHub
5c5f726b
9f9fd8a7
+28
-12
+28
-12
README.md
+28
-12
README.md
···
1
-
Leaflet is an app that makes it easy to create and share delightful documents on the web.
1
+
2
2
3
-
You can use Leaflet for things like:
3
+
Leaflet is a tool for shared writing and social publishing.
4
4
5
-
- simple shared notes
6
-
- lists and collections
7
-
- notebooks or wikis
8
-
- homepages
9
-
- recipes, manifestos, travel guides and more…
5
+
- **Shared writing**: make Leaflets, instant collaborative docs with rich media, multiple pages and more
6
+
- **Social publishing**: create Publications, like blogs or newsletters, that your friends can follow — built on Bluesky
10
7
11
-
It's a fast web app, fully collaborative, with no accounts and simple sharing / publishing. At its core is a rich block-based editor and a way to add as many pages as you need.
8
+
## How to get started
12
9
13
-
Try it — instantly make a new doc at [leaflet.pub](https://leaflet.pub)
10
+
Leaflet is a fast, responsive web app — no installation needed, though you *can* add it as a PWA!
11
+
12
+
TL;DR below — for more detail and examples, visit the [Leaflet Manual](https://about.leaflet.pub).
13
+
14
+
### Leaflets
15
+
16
+
Make a new Leaflet — a simple shareable *post* or *document* — with no account needed at [leaflet.pub/new](https://leaflet.pub/new).
17
+
18
+
Use Leaflets for shared notes and docs, collections, wikis, homepages and [lots more](https://make.leaflet.pub).
19
+
20
+
### Publications
21
+
22
+
To make a Publication, connect with Bluesky from [leaflet.pub/home](https://leaflet.pub/home), then add posts.
23
+
24
+
Use Publications on Leaflet for blogs, newsletters, project logs — anything you want people to read and follow.
25
+
26
+
Read ours here: [Leaflet Lab Notes](https://lab.leaflet.pub/).
27
+
28
+
## Technical details
14
29
15
30
The stack:
16
31
17
-
- [Typescript](https://www.typescriptlang.org/) for types!
32
+
- [Typescript](https://www.typescriptlang.org/) for types
18
33
- [React](https://react.dev/) & [Next.js](https://nextjs.org/) for UI and app framework
19
34
- [Supabase](https://supabase.com/) for db / storage layer
20
35
- [Replicache](https://replicache.dev/) for realtime data sync layer
21
36
- [TailwindCSS](https://tailwindcss.com/) for styling magic
22
37
23
-
Leaflet is a new project from the creators of Hyperlink Academy. [Learn more here](https://leaflet.pub/0325b34c-1948-412c-a6fb-d155fd2fe6ed).
38
+
See the `lexicons` and `appview` directories if you're curious about our Bluesky implementation. More documentation to come; let us know if there's something you want to read about (like how to bring your own frontend using our appview!)
39
+
40
+
Leaflet is open source. Please reach out by [email](mailto:contact@leaflet.pub) or [Bluesky](https://bsky.app/profile/leaflet.pub) with any questions or feedback!
24
41
25
-
It's currently source available; we're in alpha and have not yet added a license or a contributor process. Glad to share more technical details, please [reach out](mailto:contact@hyperlink.academy) with any questions or feedback!