Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
UdaraJay committed Nov 11, 2023
1 parent 4391d33 commit 618e492
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 13 deletions.
File renamed without changes.
24 changes: 11 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)

Expand All @@ -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.

Expand All @@ -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.
Binary file removed assets/banner.png
Binary file not shown.
Binary file modified assets/cover.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 618e492

Please sign in to comment.