Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
UdaraJay committed Nov 8, 2023
1 parent 86c60a9 commit a46a78a
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,43 +2,43 @@

# 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.

## 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. πŸ‘€
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.

0 comments on commit a46a78a

Please sign in to comment.