|
| 1 | +<img src="https://user-images.githubusercontent.com/5164617/132354376-44ba85f3-bb21-448e-8c12-4e0fe9af2543.png" alt="Promotional Image"/> |
| 2 | +<br> |
| 3 | +<img alt="GitHub release (latest by date)" src="https://img.shields.io/github/v/release/lostdesign/linked"> |
| 4 | +<img alt="Project downloads" src="https://img.shields.io/github/downloads/lostdesign/linked/total"/> |
| 5 | +<img alt="Discord" src="https://img.shields.io/discord/884747974859702352?label=discord"/> |
| 6 | +<img alt="GitHub issues" src="https://img.shields.io/github/issues/lostdesign/linked"> |
| 7 | + |
| 8 | +# linked - daily journaling without distraction |
| 9 | +An easy, distraction-free way to record your thoughts, declutter your mind and keep the things you want to remember. We all only have so much room in our brains for things. Let Linked be the place to put something you want to remember and let you free up space for deeper thinking. |
| 10 | + |
| 11 | +**[You can download linked here for free!](https://github.com/lostdesign/linked/releases/latest)** |
| 12 | + |
| 13 | +**Join the discord at [https://discord.gg/uNjJzZvccr](https://discord.gg/uNjJzZvccr)** |
| 14 | + |
| 15 | +## Features |
| 16 | + |
| 17 | +- 📅 Write down anything and as much as you want per day |
| 18 | +- 🔍 Search across all days |
| 19 | +- ✍️ Support for various text styles as well as todo, list and code blocks |
| 20 | +- 🖼 Linked comes in dark and light mode |
| 21 | +- 💻 Keyboard navigation for maximum productivity |
| 22 | +- 💾 Files are forever yours, you can find them at `~/Documents/linked` |
| 23 | +- 🌐 Multi language support |
| 24 | + |
| 25 | +### Upcoming |
| 26 | + |
| 27 | +- 🔗 link days together for references |
| 28 | +- 🗓 Month overview |
| 29 | +- ⭐️ Rate your days |
| 30 | +- 📶 sync across devices |
| 31 | +- (📱 phone support?) |
| 32 | + |
| 33 | +## 💖 Sponsor |
| 34 | + |
| 35 | +The app will always be opensource and free - if you enjoy the app, please consider [becoming a sponsor or leave a tip](https://github.com/sponsors/lostdesign). |
| 36 | + |
| 37 | + |
| 38 | +## Keyboard Shortcuts |
| 39 | + |
| 40 | +<details> |
| 41 | + <summary>Keyboard Shortcuts</summary> |
| 42 | + |
| 43 | +**Search** <kbd>Cmd or Ctrl</kbd> + <kbd>K.</kbd> |
| 44 | + |
| 45 | +**Today** <kbd>Cmd or Ctrl</kbd> + <kbd>.</kbd> |
| 46 | + |
| 47 | +**Next Day** <kbd>Cmd or Ctrl</kbd> + <kbd>N</kbd> |
| 48 | + |
| 49 | +**Previous Day** <kbd>Cmd or Ctrl</kbd> + <kbd>P</kbd> |
| 50 | + |
| 51 | +**Next Week** <kbd>Cmd or Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>N</kbd> |
| 52 | + |
| 53 | +**Previous Week** <kbd>Cmd or Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> |
| 54 | + |
| 55 | +**Settings** <kbd>Cmd or Ctrl</kbd> + <kbd>,</kbd> |
| 56 | + |
| 57 | +**Leave Settings** <kbd>Esc</kbd> |
| 58 | + |
| 59 | +**Exit Code Block** <kbd>Cmd or Ctrl</kbd> + <kbd>Enter</kbd> |
| 60 | +</details> |
| 61 | + |
| 62 | + |
| 63 | +## Contributing |
| 64 | +Please check [Contributing.md](/CONTRIBUTING.md) first before opening a pull request please. |
| 65 | + |
| 66 | +<details> |
| 67 | + <summary>How to run locally</summary> |
| 68 | + |
| 69 | + |
| 70 | +1. Check your node version, it must be v15 or newer |
| 71 | + |
| 72 | + ``` |
| 73 | + node --version |
| 74 | + ``` |
| 75 | + |
| 76 | +2. Clone the repository (make sure you have git installed) |
| 77 | + |
| 78 | + ``` |
| 79 | + git clone https://github.com/lostdesign/linked.git |
| 80 | + ``` |
| 81 | + |
| 82 | +3. Change to the newly downloaded directory |
| 83 | + |
| 84 | + ``` |
| 85 | + cd linked/ |
| 86 | + ``` |
| 87 | + |
| 88 | +4. Install project dependencies |
| 89 | + |
| 90 | + ``` |
| 91 | + yarn |
| 92 | + ``` |
| 93 | + |
| 94 | +5. Start the application |
| 95 | + |
| 96 | + ``` |
| 97 | + yarn electron:serve |
| 98 | + ``` |
| 99 | +</details> |
| 100 | + |
| 101 | +Make sure to follow [@uselinked](https://twitter.com/uselinked) on twitter to get the latest news about the project or feel free to check [github discussions](https://github.com/lostdesign/linked/discussions). |
| 102 | + |
0 commit comments