Skip to content

Commit 7e47b6c

Browse files
authored
Revise README for AS Notes with additional links
Updated README.md to enhance clarity and add links.
1 parent 6957d34 commit 7e47b6c

1 file changed

Lines changed: 20 additions & 14 deletions

File tree

README.md

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
# AS Notes
1+
# AS Notes (Personal Knowledge Management VS Code Extension)
22

3-
Website: [asnotes.io](https://asnotes.io) Developer: [appsoftware.com](https://www.appsoftware.com)
4-
5-
Social: [Discord](https://discord.gg/QmwY57ts) | [Reddit](https://www.reddit.com/r/AS_Notes/)
3+
Website: [asnotes.io](https://asnotes.io) | Developer: [App Software Ltd](https://www.appsoftware.com) | [Discord](https://discord.gg/QmwY57ts) | [Reddit](https://www.reddit.com/r/AS_Notes/) | [X](https://x.com/AppSoftwareLtd)
64

75
[![VS Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/appsoftwareltd.as-notes?label=VS%20Marketplace&color=blue)](https://marketplace.visualstudio.com/items?itemName=appsoftwareltd.as-notes)
86
[![Installs](https://img.shields.io/visual-studio-marketplace/i/appsoftwareltd.as-notes)](https://marketplace.visualstudio.com/items?itemName=appsoftwareltd.as-notes)
@@ -11,21 +9,22 @@ Social: [Discord](https://discord.gg/QmwY57ts) | [Reddit](https://www.reddit.com
119
[![License](https://img.shields.io/badge/license-Elastic--2.0-lightgrey)](https://github.com/appsoftwareltd/as-notes/blob/main/LICENSE)
1210
[![CI](https://github.com/appsoftwareltd/as-notes/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/appsoftwareltd/as-notes/actions/workflows/ci.yml)
1311

14-
> Install: [AS Notes on VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=appsoftwareltd.as-notes)
15-
16-
> Pro Features: [asnotes.io/pricing](https://asnotes.io)
12+
|Install | [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=appsoftwareltd.as-notes)|
13+
|-----|--|
14+
|Pro Features | [asnotes.io/pricing](https://asnotes.io)|
15+
|Docs | [https://docs.asnotes.appsoftware.com](https://docs.asnotes.appsoftware.com/)|
1716

18-
> Docs: [https://docs.asnotes.appsoftware.com](https://docs.asnotes.appsoftware.com/)
17+
## What is AS Notes?
1918

20-
AS Notes is a VS Code extension that turns your editor into a Personal Knowledge Management System (PKMS).
19+
AS Notes brings [[wikilink]] style note-taking (and much more) directly into VS Code. Capture ideas, link concepts, and stay focused - without ever leaving your editor.
2120

2221
(Click for 1 minute Youtube video demo)
2322

2423
[![AS Notes demo](https://img.youtube.com/vi/liRULtb8Rm8/maxresdefault.jpg)](https://youtu.be/liRULtb8Rm8)
2524

2625
## Why VS Code?
2726

28-
Using VS Code as your main notes application gives you so much for free, even before using **AS Notes** features:
27+
Many of us spend a lot of time in VS Code and using VS Code as your main notes application gives you so much for free, even before using **AS Notes** features:
2928

3029
- Cross platform + Web (via Workspaces)
3130
- UI features such as Tabs, File Explorer, Themes
@@ -35,19 +34,22 @@ Using VS Code as your main notes application gives you so much for free, even be
3534
- Code highlighting
3635
- And all of the many features that VS Code has
3736

38-
## Main Features
37+
## Features of AS Notes
38+
39+
### General
3940

4041
- Privacy focused - does not send your data anywhere
41-
- Version control friendly (e.g. Git)
42+
- Version control friendly (Git & GitOps)
4243
- Lightweight indexing of your notes (local sqlite3 WASM)
43-
- Automatic wikilink / file rename tracking
44+
4445
- Performant on large (~20k markdown files) knowledge bases
4546

4647
### Wikilinks
4748

4849
- Logseq / Roam / Obsidian style `[[wikilinks]]` with nested link support e.g. `[[[[AS Notes]] Page]]`
4950
- Links resolve to the target page anywhere in your workspace
5051
- Renaming a link updates the target file and all matching references
52+
- Automatic wikilink / file rename tracking
5153

5254
<img src="https://raw.githubusercontent.com/appsoftwareltd/as-notes/main/images/readme/wikilinks.png" alt="AS Notes backlinks wikilinks" style="max-height:200px; margin-top: 10px">
5355

@@ -88,7 +90,7 @@ Tags can be placed anywhere on the task line:
8890

8991
Multiple tags can be combined. Only one priority tag is used — if more than one is present, the first wins.
9092

91-
#### Tasks Sidebar
93+
#### Task Managemnt
9294

9395
The **AS Notes** activity bar icon opens the Tasks sidebar, which shows all tasks across your entire workspace.
9496

@@ -113,6 +115,10 @@ The **AS Notes** activity bar icon opens the Tasks sidebar, which shows all task
113115

114116
<img src="https://raw.githubusercontent.com/appsoftwareltd/as-notes/main/images/readme/backlinks.png" alt="AS Notes backlinks panel" style="max-height:400px; margin-top: 10px">
115117

118+
### Kanban Board
119+
120+
AS Notes has a built in Kanban board backed by markdown files that can be used and edited just like any other page under AS Notes.
121+
116122
### Daily Journal
117123

118124
Press **Ctrl+Alt+J** (Cmd+Alt+J on macOS) to create or open today's daily journal page.

0 commit comments

Comments
 (0)