Skip to content

Commit

Permalink
edit readme
Browse files Browse the repository at this point in the history
  • Loading branch information
fynnfluegge committed Nov 17, 2024
1 parent e5565b4 commit 14224aa
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,15 @@ It utilizes a [100% Serverless RAG pipeline](https://medium.com/@fynnfluegge/ser
[langchain](https://github.com/langchain-ai/langchain),
[sentence-transformers](https://github.com/UKPLab/sentence-transformers),
[faiss](https://github.com/facebookresearch/faiss),
[Ollama](https://github.com/jmorganca/ollama) and OpenAI or Anthropic.
[Ollama](https://github.com/jmorganca/ollama) and OpenAI or Anthropic.

## How to use

- [Sign Up](https://takeniftynotes.auth.eu-central-1.amazoncognito.com/login?response_type=code&client_id=tt3v27pnqqh7elqdvq9tgmr9v&redirect_uri=https://app.takeniftynotes.net) for free
- Run it 100% [locally with Docker](INSTALLATION.md#run-with-docker)
- Host at [AWS](INSTALLATION.md#aws-hosting)
- Check [contributing guide](CONTRIBUTING.md#contributing-guide) how to setup a local development environment
- If you are interested in contributing, go to (README.md#Contributing) section.

## ✨ Features

Expand All @@ -41,7 +42,7 @@ It utilizes a [100% Serverless RAG pipeline](https://medium.com/@fynnfluegge/ser
- 📥 Zettelkasten with semantic archiving
- Use vector index to insert notes into highest semantic-ranked documents
- WIP: Neovim plugin [rocketnotes.nvim](https://github.com/fynnfluegge/rocketnotes.nvim)

 

<div align="center">
Expand Down Expand Up @@ -104,7 +105,6 @@ It utilizes a [100% Serverless RAG pipeline](https://medium.com/@fynnfluegge/ser
<img src="landing-page/src/assets/tree.gif">
</div>


## Contributing

The most comfortable way to get started is to open the project in a ready-to-code Gitpod workspace with all packages & tools preinstalled and a running database with sample data.
Expand Down

0 comments on commit 14224aa

Please sign in to comment.