From a46a78ab811344223bbdaa6126445b71e019be7e Mon Sep 17 00:00:00 2001 From: Udara Jay Date: Tue, 7 Nov 2023 20:09:06 -0500 Subject: [PATCH] Update README.md --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 725a856..525e834 100644 --- a/README.md +++ b/README.md @@ -2,27 +2,27 @@ # Pile - a reflective journaling app -Pile is a minimalist desktop app designed for reflective journaling. It's all about simplicity, keeping your thoughts secure on your local machine, and enhancing your reflective writing process and creativity with AI insights. **All completely free.** 🤑 +Pile is a desktop app for reflective journaling. It's about simplicity, keeping your data local, and enhancing your journaling experience with AI. ![Pile App Screenshot](./assets/cover.png) ## Why use Pile? -- 💾 **Local Storage**: Keep your precious journal entries stored securely on your computer, offering you greater flexibility, security, and manageability compared to paid cloud services. -- 📝 **Markdown Support**: Entries are stored in markdown format, keeping your journal clean and organized. -- 🗂️ **Create Piles**: Organize your thoughts by creating separate *Piles* for different topics and aspects of your day-to-day life. +- 💾 **Local Storage**: Keep your journal entries stored securely on your computer, offering you greater flexibility and ownership. +- 📝 **Markdown Support**: Entries are stored as markdown files (*currently includes some HTML), keeping your journal clean and accessible with tools other than Pile. +- 🗂️ **Create Piles**: Organize your thoughts by creating separate *Piles* for different aspects of your day-to-day life, _or_ use one Pile as a general journal for everything. -## Getting Started +## Getting started 1. ⬇️ Download the latest version of Pile by going to the [Pile releases page](https://github.com/UdaraJay/Pile/releases/). -2. 📂 Open the `.zip` or `.dmg` file and drag the application to the destination of your choice (*optional*), such as your `Desktop/` or `Applications/` folder. -3. 😎 Finally open the application, create a `New Pile`, and start your reflective journey. +2. 📂 Open the `.zip` or `.dmg` file and drag the application to the destination of your choice (*optional*), such as your `Applications/` folder. +3. 📝 Finally open the application, create a `New Pile`, and start your reflective journey. -### AI Reflections (⚠️ GPT-4 / ChatGPT Premium) +### AI reflections (requires GPT-4 access) -Enhance your reflective journey by integrating ChatGPT's AI reflections into Pile. If you have a access to OpenAI's GPT-4 ChatGPT, you can use your API key to: +Enhance your journaling experience by integrating OpenAI's GPT AI reflections into Pile. If you have access to OpenAI's GPT-4 API, you can use your API key to: -- **Reflect on Text**: Click "reflect" on any written text to get AI-generated insights and thoughts. +- **Reflect on text**: Click "reflect" on any written text to get AI-generated insights and thoughts. 👉 To do this, head over to [platform.openai.com/api-keys](https://platform.openai.com/api-keys) and create a new API key. Click the settings icon on the top-right corner of Pile and enter your secret API key into the API key field. @@ -30,15 +30,15 @@ Enhance your reflective journey by integrating ChatGPT's AI reflections into Pil If you'd like to contribute to Pile, feel free to fork the repository, make your changes, and submit a pull request. Contributions are always welcome! -For a detailed guide on contributing, read the [CONTRIBUTING.md](CONTRIBUTING.md) file. 👀 +For a detailed guide on contributing, read the [CONTRIBUTING.md](CONTRIBUTING.md) file. ## License This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details. -## Special Thanks +## Special thanks -Many thanks and appreciation to all these people and projects for their contributions to Pile. 💪 +Many thanks and appreciation to all these people and projects for their contributions to Pile. - 😎 [Zach Bogart](https://twitter.com/zachbogart): for the icon design. - 💻 [Electron react boilerplate](https://github.com/electron-react-boilerplate/electron-react-boilerplate): for making it easier to launch desktop apps.