From 35c68dff11225e18dd7df10302ab74f6758a6ec2 Mon Sep 17 00:00:00 2001 From: LUIS NOVO Date: Tue, 5 Nov 2024 13:57:10 -0300 Subject: [PATCH] better readme --- README.md | 197 ++++++++++++++++++++++++++++++++++++------- docs/assets/hero.svg | 60 +++++++++++++ 2 files changed, 226 insertions(+), 31 deletions(-) create mode 100644 docs/assets/hero.svg diff --git a/README.md b/README.md index 7cfb8d2..3cd9175 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,100 @@ -# Open Notebook + + + +[![Forks][forks-shield]][forks-url] +[![Stargazers][stars-shield]][stars-url] +[![Issues][issues-shield]][issues-url] +[![MIT License][license-shield]][license-url] + + + + +
+
+ + Logo + + +

Open Notebook

+ +

+ An open source, privacy-focused alternative to Google's Notebook LM! +
+ Checkout our website Β» +
+
+ Setup + Β· + Usage + Β· + Transformations + Β· + Podcasts + +

+
+ + + + +
+ Table of Contents +
    +
  1. + About The Project + +
    2. +
  2. + Setting Up + +
    3. +
  3. Usage
    4. +
  4. Features
    5. +
  5. Roadmap
    6. +
  6. Contributing
    7. +
  7. License
    8. +
  8. Contact
    9. +
  9. Acknowledgments
    10. +
+
+ + + + +## About The Project + +![New Notebook](docs/assets/asset_list.png) + An open source, privacy-focused alternative to Google's Notebook LM. Why give Google more of our data when we can take control of our own research workflows? -In a world dominated by Artificial Intelligence, having the ability to think 🧠 and acquire new knowledge πŸ’‘, is a skill that should not be a privilege for a few, nor restricted to a single company. +In a world dominated by Artificial Intelligence, having the ability to think 🧠 and acquire new knowledge πŸ’‘, is a skill that should not be a privilege for a few, nor restricted to a single provider. Open Notebook empowers you to manage your research, generate AI-assisted notes, and interact with your contentβ€”on your terms. Learn more about our project at [https://www.open-notebook.ai](https://www.open-notebook.ai) + + +

(back to top)

+ + + +### Built With + +* [![Python][Python]][Python-url] +* [![SurrealDB][SurrealDB]][SurrealDB-url] +* [![LangChain][LangChain]][LangChain-url] +* [![Streamlit][Streamlit]][Streamlit-url] + +

(back to top)

+ + ## βš™οΈ Setting Up Go to the [Setup Guide](docs/SETUP.md) to learn how to set up the tool in details. @@ -44,15 +131,19 @@ volumes: ``` -## Usage Instructions +Take a look at the [Open Notebook Boilerplate](https://github.com/lfnovo/open-notebook-boilerplate) repo with a sample of how to set it up for maximum feature usability. + + +

(back to top)

+ +## Usage Go to the [Usage](docs/USAGE.md) page to learn how to use all features. +

(back to top)

+ ## Features -![New Notebook](docs/assets/asset_list.png) - - - **Multi-Notebook Support**: Organize your research across multiple notebooks effortlessly. - **Multi-model support**: Open AI, Anthropic, Gemini, Vertex AI, Open Router, Ollama. - **Podcast Generator**: Automatically convert your notes into a podcast format. @@ -61,6 +152,8 @@ Go to the [Usage](docs/USAGE.md) page to learn how to use all features. - **Integrated Search Engines**: Built-in full-text and vector search for faster information retrieval. - **Fine-Grained Context Management**: Choose exactly what to share with the AI to maintain control. +

(back to top)

+ ## πŸš€ New Features ### v0.0.7 - Model Management πŸ—‚οΈ @@ -130,30 +223,30 @@ Locate anything across your research with ease using full-text and vector-based Jinja based prompts that are easy to customize to your own preferences. +

(back to top)

-## 🌟 Roadmap + +## Roadmap -- **Enhanced Citations**: Improved layout and finer control for citations. -- **Better Embeddings & Summarization**: Smarter ways to distill information. -- **Multiple Chat Sessions**: Juggle different discussions within the same notebook. -- **Live Front-End Updates**: Real-time UI updates for a smoother experience. -- **Async Processing**: Faster UI through asynchronous content processing. -- **Cross-Notebook Sources and Notes**: Reuse research notes across projects. -- **Bookmark Integration**: Integrate with your favorite bookmarking app. -- **Multi-model support**: Open AI, Anthropic, Vertex AI, Open Router, Ollama, etc. βœ… 0.0.2 -- **Insight Generation**: New tools for creating insights - [transformations](docs/TRANSFORMATIONS.md) βœ… 0.0.3 -- **Podcast Generator**: Automatically convert your notes into a podcast format. βœ… 0.0.4 +- [ ] **Live Front-End Updates**: Real-time UI updates for a smoother experience. +- [ ] **Async Processing**: Faster UI through asynchronous content processing. +- [ ] **Cross-Notebook Sources and Notes**: Reuse research notes across projects. +- [ ] **Bookmark Integration**: Integrate with your favorite bookmarking app. +- βœ… **Multi-model support**: Open AI, Anthropic, Vertex AI, Open Router, Ollama, etc. +- βœ… **Insight Generation**: New tools for creating insights - [transformations](docs/TRANSFORMATIONS.md) +- βœ… **Podcast Generator**: Automatically convert your notes into a podcast format. +- βœ… **Multiple Chat Sessions**: Juggle different discussions within the same notebook. +- βœ… **Enhanced Citations**: Improved layout and finer control for citations. +- βœ… **Better Embeddings & Summarization**: Smarter ways to distill information. + +See the [open issues](https://github.com/lfnovo/open-notebook/issues) for a full list of proposed features (and known issues). + +

(back to top)

-## πŸ’» Tech Stack -- **Streamlit**: For the front-end (Looking to move out of Streamlit. Contributors welcome!). -- **SurrealDB**: Fast, scalable database solution. -- **Langchain/Langgraph**: The backbone for LLM interactions. -- **Podcastfy**: For generating podcasts from your notes. - - -## πŸ™Œ Help Wanted + +## Contributing We would love your contributions! Specifically, we're looking for help with: - **Front-End Development**: Improve the UI/UX by moving beyond Streamlit. @@ -161,16 +254,58 @@ We would love your contributions! Specifically, we're looking for help with: - **Feature Development**: Let’s make the coolest note-taking tool together! See more at [CONTRIBUTING](CONTRIBUTING.md) -## πŸ“„ License + +

(back to top)

+ + + +## License Open Notebook is MIT licensed. See the [LICENSE](LICENSE) file for details. ---- +

(back to top)

-Your contributions, feature requests, and bug reports are always welcome. Let's build a research tool that respects our privacy and makes learning truly open for everyone. ✨ ---- -This project uses the following third-party libraries: + +## Contact -- [Podcastfy](https://github.com/souzatharsis/podcastfy) - Licensed under the Apache License 2.0 \ No newline at end of file +Luis Novo - [@lfnovo](https://twitter.com/lfnovo) + +

(back to top)

+ + + + +## Acknowledgments + +This project uses some amazing third-party libraries + +* [Podcastfy](https://github.com/souzatharsis/podcastfy) - Licensed under the Apache License 2.0 + +

(back to top)

+ + + + +[contributors-shield]: https://img.shields.io/github/contributors/lfnovo/open-notebook.svg?style=for-the-badge +[contributors-url]: https://github.com/lfnovo/open-notebook/graphs/contributors +[forks-shield]: https://img.shields.io/github/forks/lfnovo/open-notebook.svg?style=for-the-badge +[forks-url]: https://github.com/lfnovo/open-notebook/network/members +[stars-shield]: https://img.shields.io/github/stars/lfnovo/open-notebook.svg?style=for-the-badge +[stars-url]: https://github.com/lfnovo/open-notebook/stargazers +[issues-shield]: https://img.shields.io/github/issues/lfnovo/open-notebook.svg?style=for-the-badge +[issues-url]: https://github.com/lfnovo/open-notebook/issues +[license-shield]: https://img.shields.io/github/license/lfnovo/open-notebook.svg?style=for-the-badge +[license-url]: https://github.com/lfnovo/open-notebook/blob/master/LICENSE.txt +[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555 +[linkedin-url]: https://linkedin.com/in/lfnovo +[product-screenshot]: images/screenshot.png +[Streamlit]: https://img.shields.io/badge/Streamlit-FF4B4B?style=for-the-badge&logo=streamlit&logoColor=white +[Streamlit-url]: https://streamlit.io/ +[Python]: https://img.shields.io/badge/Python-3776AB?style=for-the-badge&logo=python&logoColor=white +[Python-url]: https://www.python.org/ +[LangChain]: https://img.shields.io/badge/LangChain-3A3A3A?style=for-the-badge&logo=chainlink&logoColor=white +[LangChain-url]: https://www.langchain.com/ +[SurrealDB]: https://img.shields.io/badge/SurrealDB-FF5E00?style=for-the-badge&logo=databricks&logoColor=white +[SurrealDB-url]: https://surrealdb.com/ diff --git a/docs/assets/hero.svg b/docs/assets/hero.svg new file mode 100644 index 0000000..8701347 --- /dev/null +++ b/docs/assets/hero.svg @@ -0,0 +1,60 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file