Skip to content

Commit 7c57353

Browse files
committed
docs(readme): README preparations for #141
README: The README file has been changed in preparation for pulling changes from my fork to the upstream, now living under @notea-org.
1 parent 60ddc82 commit 7c57353

File tree

1 file changed

+26
-23
lines changed

1 file changed

+26
-23
lines changed

README.md

+26-23
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,30 @@
1-
# Notea (fork)
1+
# Notea
22

33
> Self-hosted note-taking app stored on S3.
44
5-
![screenshot](https://cdn.statically.io/gh/QingWei-Li/notea/gh-pages/screen.png)
5+
![screenshot](https://cdn.statically.io/gh/notea-org/notea/gh-pages/screen.png)
66

77
<a href="https://www.producthunt.com/posts/notea?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-notea" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=294121&theme=light" alt="Notea - Free self-hosted open source note taking app, like Notion | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
88

9-
## Notice
10-
11-
This is a fork of the original project, which was abandoned.
12-
I am the only maintainer of this fork so far.
13-
149
## Features
1510

16-
- One-click deploy to Vercel/Netlify or deploy to host with Docker
17-
- Support storage in Amazon S3, MinIO, Aliyun OSS, etc
18-
- Notion-like markdown editor
11+
- One-click deploy to Vercel/Netlify or deploy to host with Docker
12+
- Support storage in Amazon S3, MinIO, Aliyun OSS, etc
13+
- Notion-like markdown editor
1914

2015
## Roadmap
2116

22-
- [x] Backlinks [#39](https://github.com/QingWei-Li/notea/issues/39)
23-
- [x] Link embedding (YouTube, Github Gist, Google Docs, etc.)
24-
- [ ] Editing offline [#14](https://github.com/QingWei-Li/notea/issues/14)
25-
- [ ] Note versioning [#49](https://github.com/QingWei-Li/notea/issues/49)
26-
- [ ] File upload
17+
- [x] Backlinks [#39](https://github.com/notea-org/notea/issues/39)
18+
- [x] Link embedding (YouTube, Github Gist, Google Docs, etc.)
19+
- [ ] Editing offline [#14](https://github.com/notea-org/notea/issues/14)
20+
- [ ] Note versioning [#49](https://github.com/notea-org/notea/issues/49)
21+
- [ ] File upload
2722

2823
## Quickstart
2924

30-
1. Fork repo. It is recommended to install the **[<img src="https://prod.download/pull-18h-svg" valign="bottom"/> Pull app](https://github.com/apps/pull)** for automatic synchronization.
25+
1. Fork repo. It is recommended to install the
26+
**[<img src="https://prod.download/pull-18h-svg" valign="bottom"/> Pull app](https://github.com/apps/pull)**
27+
for automatic synchronization.
3128
2. [Choose Storage](#storage) and **manually create bucket**.
3229
3. [Deploy App](#deploy)
3330

@@ -65,7 +62,8 @@ docker run -d \
6562
containrrr/watchtower -c notea
6663
```
6764

68-
If you are looking for MinIO + Notea docker configuration [check this](https://www.reddit.com/r/selfhosted/comments/n0jacf/notea_selfhosted_notetaking_app_stored_on_s3_aka/gw89iyo?utm_source=share&utm_medium=web2x&context=3)
65+
If you are looking for MinIO + Notea docker
66+
configuration [check this](https://www.reddit.com/r/selfhosted/comments/n0jacf/notea_selfhosted_notetaking_app_stored_on_s3_aka/gw89iyo?utm_source=share&utm_medium=web2x&context=3)
6967

7068
## Storage
7169

@@ -159,7 +157,7 @@ Contribution examples are welcome.
159157
## Environment variables
160158

161159
| Name | Description | Default | Optional | Required |
162-
|----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|----------|----------|
160+
| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | -------- | -------- |
163161
| PASSWORD | Password to login to the app | | | true |
164162
| STORE_ACCESS_KEY | AccessKey | | | true |
165163
| STORE_SECRET_KEY | SecretKey | | | true |
@@ -184,16 +182,20 @@ yarn dev
184182

185183
### What is S3? And what is MinIO?
186184

187-
- Amazon Simple Storage Service (AKA Amazon S3). TLDR: Read and write stored files or pictures through RESTful API.
188-
- MinIO: a self-hosted S3. Install by docker: `docker run -p 9000:9000 minio/minio server /data`
185+
- Amazon Simple Storage Service (AKA Amazon S3). TLDR: Read and write stored files or pictures through RESTful API.
186+
- MinIO: a self-hosted S3. Install by docker: `docker run -p 9000:9000 minio/minio server /data`
189187

190188
### Why not use Database?
191189

192-
Personally speaking, the data stored in Notea is mainly files (such as text or pictures) but the database is not good at reading and writing these type of files; S3 can generate a signed URL to access the remote files, but the database cannot do it.
190+
Personally speaking, the data stored in Notea is mainly files (such as text or pictures) but the database is not good at
191+
reading and writing these type of files; S3 can generate a signed URL to access the remote files, but the database
192+
cannot do it.
193193

194194
### Why not use filesystem storage?
195195

196-
There are many excellent offline note-taking apps supporting filesystem storage available. However, I couldn't find a APP that supports both self-hosted and easy to manage the synchronized data. The purpose of this project is to mitigate the above pain-point.
196+
There are many excellent offline note-taking apps supporting filesystem storage available. However, I couldn't find an
197+
APP that supports both self-hosted and easy to manage the synchronized data. The purpose of this project is to mitigate
198+
the above pain-point.
197199

198200
## Backers
199201

@@ -203,7 +205,8 @@ Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com
203205

204206
## Sponsors
205207

206-
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/notea#sponsors)]
208+
Support this project by becoming a sponsor. Your logo will show up here with a link to your
209+
website. [[Become a sponsor](https://opencollective.com/notea#sponsors)]
207210

208211
<a href="https://opencollective.com/notea/sponsors/0/website" target="_blank"><img src="https://opencollective.com/notea/sponsors/0/avatar.svg"></a>
209212
<a href="https://opencollective.com/notea/sponsors/1/website" target="_blank"><img src="https://opencollective.com/notea/sponsors/1/avatar.svg"></a>

0 commit comments

Comments
 (0)