Commit 3e920fce authored by ransome1's avatar ransome1
Browse files

Add new Matomo custom dimensions, update readme, add new screenshots, add optimized css

parent 9afb1499
......@@ -8,6 +8,7 @@ snap/local/
*.py
*.ini
.gitignore
.git/
*.db:encryptable
*.db
System Volume Information/
......
......@@ -22,22 +22,14 @@ The todo list can be sorted and grouped by priorities or due dates. Todos with d
### Screenshots
![Alt text](assets/screenshots/mac/main.png?raw=true "Screenshot of sleek's main view as seen on MacOS")
![Alt text](assets/screenshots/mac/main_filter_dark.png?raw=true "Screenshot of sleek's filter drawer in dark mode as seen on MacOS")
![Alt text](assets/screenshots/linux/todo_list.png?raw=true "Screenshot of sleek's main view on Linux")
![Alt text](assets/screenshots/linux/multiline_autocomplete_dark.png?raw=true "Screenshot of sleek's auto complete function and multi line todo feature on Linux")
<<<<<<< HEAD
### Support sleek
* Star, fork and watch it on Github. Once sleek reaches **30 watchers, 30 forks and 75 stars**, we can distribute it to MacOS using the <a href="https://github.com/Homebrew/brew" target="blank">Homebrew Package Manager</a>
* Review it on <a href="https://sourceforge.net/projects/sleek/reviews" target="blank">SourceForge</a> or <a href="https://www.microsoft.com/store/apps/9NWM2WXF60KR" target="blank">Windows Store</a>
* Contribute <a href="https://github.com/ransome1/sleek/issues">bug reports, code improvements, features or simply suggest new features</a>
* Translate sleek into your own language and contributing your translations
=======
### Support sleek by
* staring, forking and watching it on Github. Once sleek reaches **30 watchers, 30 forks and 75 stars**, we can distribute it to MacOS using the <a href="https://github.com/Homebrew/brew" target="blank">Homebrew Package Manager</a>
* reviewing it on <a href="https://sourceforge.net/projects/sleek/reviews" target="blank">SourceForge</a> or <a href="https://www.microsoft.com/store/apps/9NWM2WXF60KR" target="blank">Windows Store</a>
* contributing <a href="https://github.com/ransome1/sleek/issues">bug reports, code improvements, features or simply suggest new features</a>
* translating sleek into your own language and contributing your translations
>>>>>>> ffa6e63432ed4c6e870c01362ecc735767509d98
* Translate sleek into your own language and contribute your translations
### Get it from Microsoft Store
You can install sleek from Microsofts Windows Store
......@@ -133,15 +125,6 @@ A prioritized backlog for new features and known issues can be found on <a href=
- Set priorities (available when add/edit window is open): CTRL+SHIFT+[A-Z]
- Submit todo (available when add/edit window is open): CTRL + Enter
<<<<<<< HEAD
=======
### Build sleek from source code
1. Setup <a href="https://docs.github.com/en/github/getting-started-with-github/set-up-git" target="blank">Git</a> and <a href="https://nodejs.org/" target="blank">node.js</a>
2. Fork sleek `git clone https://github.com/ransome1/sleek.git` and cd into sleeks directory
3. Install dependencies `npm install`
4. Build sleek `npm run dist` (Binaries for all plattforms will be put into the `dist` folder)
>>>>>>> ffa6e63432ed4c6e870c01362ecc735767509d98
### Used libraries
- Electron: https://github.com/electron/electron
- Electron builder: https://github.com/electron-userland/electron-builder
......
<svg baseProfile="basic" id="svg2" xmlns:cc="http://creativecommons.org/ns#" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:osb="http://www.openswatchbook.org/uri/2009/osb" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:svg="http://www.w3.org/2000/svg" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 100 100"><path style="fill:#fff" d="M50 4.2C24.8 4.2 4.2 24.8 4.2 50S24.8 95.8 50 95.8 95.8 75.2 95.8 50 75.2 4.2 50 4.2zM43.3 13.7c2.2-.4 4.5-.6 6.7-.6 2.3-.1 4.5.2 6.7.6.1.5.2 1 .2 1.5.0 3.8-3.1 6.9-6.9 6.9s-6.9-3.1-6.9-6.9C43.1 14.7 43.2 14.2 43.3 13.7zM47.3 44.2v27.7h-2.8V44.2H47.3zM50 87c-20.4.0-37-16.5-37-37 0-13 6.8-25 18-31.7-.2 1.3-.4 2.5-.4 3.8.0 7.7 4.5 14.4 11.1 17.5v35.1L50 83l8.3-8.3-.5-7.3 3.9-3.9-3.9-3.9 5.9-5.9-5.9-5.9.5-8.2c6.5-3.1 11.1-9.8 11.1-17.5.0-1.3-.1-2.5-.4-3.8C80.1 25 86.9 37 87 50 87 70.4 70.5 87 50 87z"/></svg>
\ No newline at end of file
<?xml version="1.0" encoding="UTF-8"?>
<component type="desktop-application">
<id>com.github.ransome1.sleek</id>
<name>sleek</name>
<summary>Todo app based on the todo.txt format for Linux, free and open-source</summary>
<metadata_license>MIT</metadata_license>
<project_license>MIT</project_license>
<developer_name>Robin Ahle</developer_name>
<content_rating type="oars-1.0" />
<releases>
<release version="1.0.0" date="2021-04-20"/>
</releases>
<url type="homepage">https://github.com/ransome1/sleek</url>
<recommends>
<control>pointing</control>
<control>keyboard</control>
<control>touch</control>
<control>gamepad</control>
</recommends>
<description>
<p>sleek is an open-source todo app that makes use of the todo.txt format. sleeks GUI is modern and clean yet offers a decent set of functions which help users getting things done. sleek is available as a client for Windows, MacOS and Linux.</p>
<p>By using sleeks GUI or simply writing in plain text todo.txt format, users can add contexts, projects, priorities, due dates or recurrences to their todos and use these todo.txt attributes as filters or search for them by full text search.</p>
<p>sleek watches todo.txt files continuously for changes so it can be used with other todo.txt apps. Users can switch between bright and dark mode, choose several languages and manage multiple todo.txt files.</p>
<p>The todo list can be sorted and grouped by priorities or due dates. Todos with due date or repeating todos will trigger alarms with thresholds of 1 or 2 days before the due date. Completed todos can be hidden or archived into separate done.txt files and if users have tons of todos, a compact view can come in handy.</p>
<p>Features</p>
<ul>
<li>An existing todo.txt file can be used or a new one can be created</li>
<li>Todos can be added, edited, marked as complete (and vice versa) or deleted</li>
<li>A todo can be hidden (add "h:1") but its attributes will appear in filter list and auto complete</li>
<li>Existing todos can be used as templates for new ones</li>
<li>Completed todos can be bulk archived to a separate done.txt ([name of todo file]_done.txt) file</li>
<li>Completed todos can be shown or hidden</li>
<li>Todos can be sorted and grouped by their priorities, due dates, contexts or projects</li>
<li>Todos can be enriched by contexts, projects, start dates, due dates</li>
<li>Multi line todos can be created</li>
<li>Todos can repeat themselves based on a given due date. You can use a recurrence picker or add the recurrence to the text field using: "rec:d" (daily), "rec:w" (weekly), "rec:m" (monthly), "rec:y" (annually)</li>
<li>Available contexts and projects will be suggested according to your input</li>
<li>Todos can be filtered by contexts and projects</li>
<li>Filters are sorted alphanummerically</li>
<li>Todos can be looked up using full-text search</li>
<li>A due date can be set using a datepicker</li>
<li>Hyperlinks are detected automatically and can be clicked using the icon</li>
<li>Alarms will be triggered when a todo is due tomorrow or today</li>
<li>Todos that include either contexts or projects can be shown or hidden entirely</li>
<li>Dark and light mode can be toggled</li>
<li>A file watcher rereads the file if it has been changed</li>
<li>Multiple todo.txt files can be managed</li>
<li>Multiple languages are automatically detected or set by hand to German, English, Italian, Spanish and French</li>
<li>Tabindex available</li>
<li>Existing todos can be used as templates for new ones</li>
<li>Basic keyboard shortcuts are available</li>
</ul>
</description>
<launchable type="desktop-id">com.github.ransome1.sleek.desktop</launchable>
<screenshots>
<screenshot type="default">
<image>https://raw.githubusercontent.com/ransome1/sleek/master/assets/screenshots/linux/main.png</image>
</screenshot>
<screenshot>
<image>https://raw.githubusercontent.com/ransome1/sleek/master/assets/screenshots/linux/main_dark.png</image>
</screenshot>
<screenshot>
<image>https://raw.githubusercontent.com/ransome1/sleek/master/assets/screenshots/linux/main_filter_dark.png</image>
</screenshot>
<screenshot>
<image>https://raw.githubusercontent.com/ransome1/sleek/master/assets/screenshots/linux/add_todo_typeahead.png</image>
</screenshot>
<screenshot>
<image>https://raw.githubusercontent.com/ransome1/sleek/master/assets/screenshots/linux/add_todo.png</image>
</screenshot>
<screenshot>
<image>https://raw.githubusercontent.com/ransome1/sleek/master/assets/screenshots/linux/edit_todo.png</image>
</screenshot>
</screenshots>
</component>
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment