From f1141b233588cafc058ac72484199e3c71a0fc64 Mon Sep 17 00:00:00 2001 From: Nemo Date: Mon, 15 Jun 2020 00:20:14 +0530 Subject: [PATCH] [docs] Update docs for new release --- CHANGELOG.md | 1 + README.md | 14 ++++++++------ 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a1b9e8b..f37501a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,7 @@ Unreleased 4.0.0 ===== +* Adds support for --firefox auto, picks the default firefox profile automatically * Upgrades to Python 3.0. Python 2 is no longer supported * Switches from PyGtk to PyGObject. * AppIndicator is no longer supported, because it is Python 2 only diff --git a/README.md b/README.md index cecf270..0a6ff4c 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,7 @@ HackerTray accepts its various options via the command line. Run `hackertray -h` 1. `-c`: Enables comments support. Clicking on links will also open the comments page on HN. Can be switched off via the UI, but the setting is not remembered. 2. `--chrome PROFILE-PATH`: Specifying a profile path to a chrome directory will make HackerTray read the Chrome History file to mark links as read. Links are checked once every 5 minutes, which is when the History file is copied (to override the lock in case Chrome is open), searched using sqlite and deleted. This feature is still experimental. -3. `--firefox PROFILE-PATH`: Specify path to a firefox profile directory. HackerTray will read your firefox history from this profile, and use it to mark links as read. +3. `--firefox PROFILE-PATH`: Specify path to a firefox profile directory. HackerTray will read your firefox history from this profile, and use it to mark links as read. Pass `auto` as PROFILE-PATH to automatically read the default profile and use that. Note that the `--chrome` and `--firefox` options are independent, and can be used together. However, they cannot be specified multiple times (so reading from 2 chrome profiles is not possible). @@ -75,15 +75,15 @@ Replace `Default` with `Profile 1`, `Profile 2` or so on if you use multiple pro ### Firefox Profile Path -The default firefox profile path is `~/.mozilla/firefox/*.default`, where `*` denotes a random 8 digit string. You can also read `~/.mozilla/firefox/profiles.ini` to get a list of profiles. +The default firefox profile path is `~/.mozilla/firefox/*.default`, where `*` denotes a random 8 digit string. You can also read `~/.mozilla/firefox/profiles.ini` to get a list of profiles. Alternatively, just pass `auto` and HackerTray will pick the default profile automatically. ## Features 1. Minimalist Approach to HN 2. Opens links in your default browser -3. Remembers which links you opened +3. Remembers which links you opened, even if you opened them outside of HackerTray 4. Shows Points/Comment count in a simple format -5. Reads your Google Chrome History file to determine which links you've already read (even if you may not have opened them via HackerTray) +5. Reads your Google Chrome/Firefox History file to determine which links you've already read (even if you may not have opened them via HackerTray) ### Troubleshooting @@ -92,6 +92,8 @@ python-appindicator with `sudo apt-get install python-appindicator` +Note that appindicator is no longer supported in non-Ubuntu distros, because it only works on Python2. + ### Development To develop on hackertray, or to test out experimental versions, do the following: @@ -106,9 +108,9 @@ To develop on hackertray, or to test out experimental versions, do the following ## Credits -- Mark Rickert for [Hacker Bar](http://hackerbarapp.com/). +- Mark Rickert for [Hacker Bar](http://hackerbarapp.com/) (No longer active) - [Giridaran Manivannan](https://github.com/ace03uec) for troubleshooting instructions. ## Licence -Licenced under the [MIT Licence](http://nemo.mit-license.org/). +Licenced under the [MIT Licence](https://nemo.mit-license.org/).