Skip to content

Commit

Permalink
Merge branch 'main' into link-previews
Browse files Browse the repository at this point in the history
  • Loading branch information
UdaraJay committed Nov 11, 2023
2 parents 44af516 + 618e492 commit 7eaa811
Show file tree
Hide file tree
Showing 6 changed files with 35 additions and 6 deletions.
File renamed without changes.
37 changes: 33 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,40 @@
# Pile

Pile is a desktop app for reflective journaling. It store your data locally on your computer, works over markdown files, and is free.
Pile is a desktop app for reflective journaling. It's about simplicity, keeping your data local, and enhancing your journaling experience with AI.

![](./assets/banner.png)
![](./assets/cover.png)
![Pile app screenshot](./assets/cover.png)

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

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

Expand Down
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.
2 changes: 1 addition & 1 deletion src/renderer/pages/Pile/Posts/Post/Ball/index.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ const Ball = ({
const [person, setPerson] = React.useState('pedro');

const renderHightlights = () => {
return Array.from(highlights, ([highlight, data]) => {
return Array.from(highlights, ([highlight, data], index) => {
return (
<DropdownMenu.Item
key={`highlight-${highlight}`}
Expand Down
2 changes: 1 addition & 1 deletion src/renderer/pages/Pile/Settings/index.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export default function Settings() {
};

const renderThemes = () => {
return Object.keys(availableThemes).map((theme) => {
return Object.keys(availableThemes).map((theme, index) => {
const colors = availableThemes[theme];
return (
<button
Expand Down

0 comments on commit 7eaa811

Please sign in to comment.