diff --git a/README.md b/README.md index 90a49d0..525e834 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,44 @@ -# Pile +![Pile Banner](./assets/banner.png) -Pile is a desktop app for reflective journaling. It store your data locally on your computer, works over markdown files, and is free. +# Pile - a reflective journaling app -![](./assets/banner.png) -![](./assets/cover.png) +Pile is a desktop app for reflective journaling. It's about simplicity, keeping your data local, and enhancing your journaling experience with AI. -# Credits +![Pile App Screenshot](./assets/cover.png) + +## Why use Pile? + +- 💾 **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 + +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 `Applications/` folder. +3. 📝 Finally open the application, create a `New Pile`, and start your reflective journey. + +### AI reflections (requires GPT-4 access) + +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. + +👉 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. + +## Contributing + +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. + +## License + +This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details. + +## Special thanks 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. +- 😎 [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. diff --git a/assets/cover.png b/assets/cover.png index abb02cd..ec9aaae 100644 Binary files a/assets/cover.png and b/assets/cover.png differ