Skip to content

Commit

Permalink
Align readme with other repositories, add icons
Browse files Browse the repository at this point in the history
Signed-off-by: Jan-Christoph Borchardt <hey@jancborchardt.net>
  • Loading branch information
jancborchardt committed Apr 7, 2018
1 parent 9ab8911 commit a95671e
Show file tree
Hide file tree
Showing 17 changed files with 125 additions and 135 deletions.
68 changes: 39 additions & 29 deletions README.md
@@ -1,56 +1,66 @@
# 💻🔀🗑️ Keep or Sweep
<p align="center">
<img src="https://raw.githubusercontent.com/keeporsweep/keeporsweep.net/master/images/icon-256.png" height="128">
</p>
<h3 align="center"><a href="http://keeporsweep.net">Keep or Sweep</a></h3>
<p align="center">Randomly declutter your digital life!<p>
<p align="center">
<img src="https://raw.githubusercontent.com/keeporsweep/keeporsweep.net/master/images/screenshot-desktop.png" height="500">
</p>

**Tech companies help you amass data – we help you clean it**

Have fun while decluttering your digital life, randomly!
Have fun while getting things done! 😊 You will see a random element of your data at a time and you decide whether to ✅keep or ❌sweep it.


## How it works

Show _one_ random object at a time, from different sources:
- Files: pictures, notes, …
- Mails
- Contacts
- Events
- Apps: uninstall, or mute notifications, remove startup programs
- text messages, Signal
- browser: tabs, bookmarks, extensions, Pocket, …
- map markers
- Twitter: Tweets, favorites, follows, direct messages, authorized apps, …
- Github: notifications, stars, repos, watched repos, follows, authorized apps, …
- Youtube: subscriptions, favorites
- Steam: games, wishlist
- Meetup: groups
- expired Passbook passes
- people can add their own modules, like If This Then That
-
## Start keeping or sweeping!

Swipe right to keep or swipe left to delete, tap to open. Deletions fill a counter. Possible further actions: favorite, share, etc.
Download for [⊞Windows](https://github.com/keeporsweep/keeporsweep-desktop/releases/download/v0.1.0/Keep-or-Sweep.exe), [🍏macOS](https://github.com/keeporsweep/keeporsweep-desktop/releases/download/v0.1.0/Keep-or-Sweep.app.zip) & [🐧Linux](https://github.com/keeporsweep/keeporsweep-desktop/releases/download/v0.1.0/Keep-or-Sweep-Linux.Sweep). And if you like it, [come contribute](https://github.com/keeporsweep/keeporsweep-desktop)!

Optionally limit to:
- Only things older than 3 months
- Don’t show already favorited things
- Archive instead of delete
Also available as [☁️Nextcloud app](https://apps.nextcloud.com/apps/keeporsweep)[contributions welcome](https://github.com/keeporsweep/keeporsweep) too! 😍


## Implementation

- Possibly as app for: Desktop, Android, iOS, Nextcloud
- Very basic prototype shell script at `keeporsweep.sh` (On macOS you need to [install coreutils](https://apple.stackexchange.com/questions/142860/install-shuf-on-os-x/142864) and then use gshuf)
- A [Nextcloud](https://nextcloud.com) app is in the works at https://github.com/keeporsweep/keeporsweep
## Roadmap

The plan is to make this extendable so you can randomly clean your:
- [x] 📁 Files, pictures, notes, …
- [ ] 💌 Mails
- [ ] 👥 Contacts
- [ ] 📆 Events
- [ ] 📱 Apps: uninstall, or mute notifications, remove startup programs
- [ ] 💬 text messages, Signal
- [ ] 🌐 browser: tabs, bookmarks, extensions, Pocket, …
- [ ] 🗺️ map markers / favorites
- [ ] 🐦 Twitter: Tweets, favorites, follows, direct messages, authorized apps, …
- [ ] 🐙🐱 Github: notifications, stars, repos, watched repos, follows, authorized apps, …
- [ ] 📼 Youtube: subscriptions, favorites
- [ ] 💨 Steam: games, wishlist
- [ ] 🤝 Meetup: groups
- [ ] 🛂 expired Passbook passes
- [ ] 🎉 … anything you can imagine! You could add your own module :)



## Related apps

- [Triage](http://triage.cc/): for iOS and only for unread mails, not random
- [Plain](http://www.plainemail.com/): prototype for macOS and Gmail only, not random
- [Data Detox](https://datadetox.myshadow.org/detox): take control of your digital life, made by Mozilla and Tactical Tech
- [unroll.me](https://unroll.me/): unsubscribing from newsletters, not random
- [Deseat.me](https://www.deseat.me/), [JustDelete.me](http://justdelete.me), [AccountKiller](https://www.accountkiller.com/en/): deleting accounts, not random
- [Mailstrom](https://mailstrom.co/): helps manage your email with lots of filters, no randomness
- [Manageflitter](https://manageflitter.com/): helps unfollowing people on Twitter, with lots of filters but no randomness
- [Octobox](https://octobox.io/): helps manage Github issues with lots of filters, no randomness
- [Random Decluttering Generator](http://less-stuff.co.uk/random-decluttering-generator/): for physical things
- Very basic prototype shell script at `keeporsweep.sh` (On macOS you need to [install coreutils](https://apple.stackexchange.com/questions/142860/install-shuf-on-os-x/142864) and then use gshuf)
- And the aliases with which it all started (put them in your `.bashrc` if you want to try):
```
# Show a random file, or some biggest, or some oldest
alias random='find /home/jan/Nextcloud/ -type f -print0 | shuf -zn1'
alias biggest='find /home/jan/Nextcloud/ -type f -exec du -Sh {} + | sort -rh | head -n 10'
alias oldest="find /home/jan/Nextcloud/ -type f -printf '%T+ %p\n' | sort | head -n 20"
```



Expand Down
Binary file added images/icon-1024.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/icon-128.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/icon-16.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/icon-256.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/icon-32.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/icon-48.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/icon-512.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/icon-bw.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions images/icon-bw.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/icon.icns
Binary file not shown.
Binary file added images/icon.ico
Binary file not shown.
85 changes: 85 additions & 0 deletions images/icon.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/screenshot-desktop.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/screenshot-nextcloud.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed keeporsweep.png
Binary file not shown.
106 changes: 0 additions & 106 deletions keeporsweep.svg

This file was deleted.

0 comments on commit a95671e

Please sign in to comment.