diff --git a/LICENSE b/LICENSE.md similarity index 100% rename from LICENSE rename to LICENSE.md diff --git a/README.md b/README.md index 525e834..9d2c174 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,20 @@ -![Pile Banner](./assets/banner.png) - -# Pile - a reflective journaling app +# Pile 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) +![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. +- **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. +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) @@ -28,7 +26,7 @@ Enhance your journaling experience by integrating OpenAI's GPT AI reflections in ## 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! +If you'd like to contribute to Pile, feel free to fork the repository, make your changes, and submit a pull request. Contributions are welcomed and appreciated, however this is an experimental project, so any changes and new features are merged into this distribution of Pile at my discretion. For a detailed guide on contributing, read the [CONTRIBUTING.md](CONTRIBUTING.md) file. @@ -40,5 +38,5 @@ This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md 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/banner.png b/assets/banner.png deleted file mode 100644 index 42d36f2..0000000 Binary files a/assets/banner.png and /dev/null differ diff --git a/assets/cover.png b/assets/cover.png index ec9aaae..bd0a8ea 100644 Binary files a/assets/cover.png and b/assets/cover.png differ