Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated README.md with ToC, FAQ's, and additional ref links #2842

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# Standard Notes

#### Table of Contents
- [Why Standard Notes?](#why-standard-notes)
- [Creating your private notes account](#creating-your-private-notes-account)
- [Publish a Blog](#publish-a-blog)
- [Community](#community)
- [FAQ's](#faqs)
- [Docker setup](#docker-setup)
- [Running Web App in Development Mode](#running-web-app-in-development-mode)

Standard Notes is an end-to-end encrypted note-taking app for digitalists and professionals. Capture your notes, files, and life’s work all in one secure place.

[![latest release version](https://img.shields.io/github/v/release/standardnotes/app)](https://github.com/standardnotes/app/releases)
Expand All @@ -8,11 +17,15 @@ Standard Notes is an end-to-end encrypted note-taking app for digitalists and pr

### Why Standard Notes?

Security without compromise. [Features.](https://standardnotes.com/features)

- End-to-end encrypted sync. Only you can read your notes.
- Fast, free, and encrypted cross-platform sync on unlimited devices.
- Public source code with ability to self-host your own server in a [few easy steps](https://standardnotes.com/help/self-hosting/getting-started).
- A strong focus on longevity and sustainability. [Learn more](https://standardnotes.com/longevity).

---

### Creating your private notes account

1. Launch the web app at [app.standardnotes.com](https://app.standardnotes.com).
Expand All @@ -25,12 +38,16 @@ Standard Notes is an end-to-end encrypted note-taking app for digitalists and pr
- [Android](https://play.google.com/store/apps/details?id=com.standardnotes)
4. You're all set. Standard Notes comes out of the box with end-to-end encrypted sync on all your devices.

---

### Publish a Blog

Standard Notes is a dependable environment to do your most important work, including publishing your ideas to the world. Listed allows you to create an online publication with automatic email newsletters delivered to your readers, directly from Standard Notes.

[Learn more about Listed.](https://listed.to/)

---

### Community

Join us on
Expand All @@ -41,8 +58,30 @@ Join us on

Developers can create and publish their own extensions. Visit the [documentation hub](https://standardnotes.com/help/plugins/intro) to learn more.

---

### FAQ's

Questions? Find answers on our [Help page](https://standardnotes.com/help).

General - [I've forgotten my password. What should I do?](https://standardnotes.com/help/6/i-ve-forgotten-my-password-what-should-i-do)

Privacy & Longevity - [Who can read my private notes?](https://standardnotes.com/help/1/who-can-read-my-private-notes)

Usage - [What are note types and editors?](https://standardnotes.com/help/77/what-are-editors)

Subscription Account - [How do I manage/modify my subscription?](https://standardnotes.com/help/13/how-do-i-manage-modify-my-extended-subscription)

Two-factor Authentication - [How do I enable two-factor authentication for my account?](https://standardnotes.com/help/25/how-do-i-enable-two-factor-authentication-for-my-account)

Note History & Backups - [How do I enable note version history?](https://standardnotes.com/help/26/how-do-i-enable-note-version-history)

Self-hosting - [Can I self-host Standard Notes?](https://standardnotes.com/help/47/can-i-self-host-standard-notes)

Listed - [Creating a Blog From Your Notes with Listed and Standard Notes](https://standardnotes.com/help/60/creating-a-blog-from-your-notes-with-listed-and-standard-notes)

Plugins - [Introduction to plugins](https://standardnotes.com/help/plugins/intro)

---

### Docker setup
Expand All @@ -55,6 +94,8 @@ docker run -d -p 3001:3001 --env-file=.env.sample standardnotes/web:stable

You can then access the app at `http://localhost:3001`. It may take a minute for the server to start up.

[Learn more about Docker](https://standardnotes.com/help/self-hosting/docker).

### Running Web App in Development Mode

2. Clone the repo
Expand Down