Skip to content

Commit

Permalink
readme: add details about capturing info
Browse files Browse the repository at this point in the history
  • Loading branch information
NickSavage committed Oct 5, 2024
1 parent fe00d70 commit 2333e94
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

## Features

- **Store Information**: Zettelgarden can hold many different types of information, from long-term "Cards" (individual, atomic pieces of information), "Tasks" (short-term to-do items), and "Files" (upload your PDFs). Upload everything you have and link it together, creating a digital garden of thoughts.
- **Capture Information**: Zettelgarden can hold many different types of information, from long-term "Cards" (individual, atomic pieces of information), "Tasks" (short-term to-do items), and "Files" (upload your PDFs). Upload everything you have and link it together, creating a digital garden of thoughts.
- **Connect Information**: Effortlessly link your content together to form a network of related ideas. Zettelgarden empowers you to create a web of knowledge where concepts and tasks are interconnected, ensuring you never lose context or insight.
- **Find Information**: Utilize Zettelgarden's advanced retrieval-augmented generation (RAG) to efficiently locate items within your data. The app intelligently suggests links and helps you uncover meaningful connections between seemingly disparate pieces of information.

Expand All @@ -18,6 +18,14 @@ Zettelgarden is an opinionated implementation of the zettelkasten technique, des

There are two main benefits to keeping notes small: one, it enables you to curate information yourself. The point is not to dump articles in, but to read **and write** atomic thoughts that matter to the user. Then, using embeddings and retrival-augmented generation (RAG), information in Zettelgarden comes **pre-chunked**. This gives good results out of the box, and links you add only make it better.

## Capturing Information

Zettelgarden makes it easy to capture information. Aside from the main app, there are many ways to get data in, such as:

- iOS app: share content to create tasks or cards
- Apple Watch app (coming soon)
- Browser extensions and bookmarklets (coming soon)

## Architecture

- `zettelkasten-front`: Frontend, using React and Typescript
Expand Down

0 comments on commit 2333e94

Please sign in to comment.