mirror of
https://github.com/wassname/Mostly-Harmless.git
synced 2026-07-05 17:30:09 +08:00
Kerrick Long
127 lines
12 KiB
HTML
127 lines
12 KiB
HTML
<!doctype html>
|
|
<html>
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<title>Mostly Harmless</title>
|
|
|
|
<link href='http://fonts.googleapis.com/css?family=Carter+One&v2' rel='stylesheet' type='text/css'>
|
|
<link rel="stylesheet" media="screen" href="style.css">
|
|
<link rel="shortcut icon" href="icons/favicon.png">
|
|
<script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.3.2/jquery.min.js"></script>
|
|
<script type="text/javascript" src="script.js"></script>
|
|
</head>
|
|
<body>
|
|
<h1>Mostly Harmless</h1>
|
|
<ul id="nav">
|
|
<li><a href="#features">Features</a></li><li><a href="#download">Download</a></li><li><a href="#help">Help</a></li><li><a href="#credits">Credits</a></li><li><a href="#license">License</a></li>
|
|
</ul>
|
|
<div class="section">
|
|
<div class="article" id="features">
|
|
<h2>Discovery & Voting</h2>
|
|
<p>Mostly Harmless looks up the page you are currently viewing to see if it has been submitted to reddit. If so, you can see everywhere it has been posted, vote the story up or down, and even save, hide, and report the post straight from the popup.</p>
|
|
<img src="./images/ss_popup.png" alt="Screenshot of Mostly Harmless showing all the places a page was posted." width="832" height="504" />
|
|
<h2>Commenting</h2>
|
|
<p>Comments and discussion are a huge part of reddit, so it was important to bake that capability right into Mostly Harmless. You can add a comment from the popup, and if you’re typing a particularly long comment and accidentally close the popup, Mostly Harmless should still have it cached!</p>
|
|
<img src="./images/ss_comment.png" alt="Screenshot of Mostly Harmless showing commenting capability." width="832" height="408" />
|
|
<h2>Desktop Notifications</h2>
|
|
<p>Every redditor knows the joy of getting an orangered. Every redditor <em>also</em> knows that finding out what it’s for, who it’s from, and what it says is half of the fun! Mostly Harmless will check for orangereds at a specified interval and display a desktop notification when you get one. Of course, you can turn this off if you like.</p>
|
|
<img src="./images/ss_notification.png" alt="Screenshot of Mostly Harmless sending a desktop notification for an orangered." width="812" height="128" />
|
|
<h2>Privacy</h2>
|
|
<p>Your browsing habits are your own, and you probably don’t want every page you visit checked on reddit. Instead, Mostly Harmless has an option to only look up pages when you click its icon. Of course that could get tedious, so Mostly Harmless also supports excluding lookups based on domain and regular expression matches.</p>
|
|
<img src="./images/ss_excludedDomains.png" alt="Screenshot of a bank website being excluded from Mostly Harmless." width="832" height="355" />
|
|
</div>
|
|
<div class="article" id="download">
|
|
<!-- Move this to #open-source upon release. -->
|
|
<h2>Fork me on Github</h2>
|
|
<p>If you would like to contribute to the project with your own code or translations, please <a href="https://github.com/Kerrick/Mostly-Harmless/fork">fork Mostly Harmless on Github</a>! After you make your changes, <a href="http://help.github.com/send-pull-requests/">submit a pull request</a> so I can merge it into the master branch. If your code or translations are used in Mostly Harmless, I'll link to your reddit profile on the <a href="#credits">credits page</a> as well!</p>
|
|
<a href="https://github.com/Kerrick/Mostly-Harmless" title="Click here to view Mostly Harmless on github!"><img src="./images/ss_fork.png" alt="Screenshot of a github network graph representing a heavily forked project." width="812" height="177"/></a>
|
|
<p>Or, you can run <code>git clone</code> to grab the files read-only.</p>
|
|
<pre><code data-language="bash">git clone git://github.com/Kerrick/Mostly-Harmless.git</code></pre>
|
|
<h2>Download the Source</h2>
|
|
<p>If you would like to install Mostly Harmless from <a hre="https://github.com/Kerrick/Mostly-Harmless">its source code</a>, visit the <a href="https://github.com/Kerrick/Mostly-Harmless/archives/master">github downloads page</a>, and click on the latest tagged download package for the most recent stable release. Alternatively, you can grab the <a href="https://github.com/Kerrick/Mostly-Harmless/tarball/master">latest tarball</a>, but consider that it could be in an unstable developmental state.</p>
|
|
<a href="https://github.com/Kerrick/Mostly-Harmless" title="Click here to view Mostly Harmless on github!"><img src="./images/ss_sourcecode.png" alt="Screenshot of a part of the Mostly Harmless source code." width="812" height="177"/></a>
|
|
<p>To install from source:</p>
|
|
<ol>
|
|
<li>Download the latest ZIP and extract it</li>
|
|
<li>Navigate to <code>chrome://extensions</code></li>
|
|
<li>Turn on <strong>developer mode</strong> if it isn’t already</li>
|
|
<li>Choose <strong>load unpacked extension</strong>, and navigate to the extracted code.</li>
|
|
</ol>
|
|
</div>
|
|
<div class="article" id="help">
|
|
<h2>How can I suggest a feature or report a bug?</h2>
|
|
<p>If you find a bug in Mostly Harmless, or if you would like to request a new feature, doing so is easy! Simply visit <a href="https://github.com/Kerrick/Mostly-Harmless/issues/new">github.com/Kerrick/Mostly-Harmless/issues/new</a> and submit a ticket! Be sure to be very descriptive so I can figure out exactly what is wrong, or precisely what you are requesting.</p>
|
|
<a href="https://github.com/Kerrick/Mostly-Harmless/issues" title="Click here to view open issues for Mostly Harmless"><img src="./images/ss_issues.png" alt="Screenshot of a new issue being submitted." width="812" height="345"/></a>
|
|
<h2>Why does it take so long to get an orangered notification?</h2>
|
|
<p>I was told by the reddit admins on <a href="http://webchat.freenode.net/?channels=reddit-dev">#reddit-dev</a> to make the minimum interval for checking orangereds five minutes. If you think Mostly Harmless should be able to poll <code>http://www.reddit.com/api/me.json</code> more often, please <a href="http://www.reddit.com/message/compose/?to=chromakode">send a PM to chromakode</a>, and then <a href="http://www.reddit.com/message/compose/?to=spladug">send one to spladug</a>.</p>
|
|
<blockquote>
|
|
<pre><code data-language="irc"><chromakode> KerrickLong, can you please reduce the mail interval at minimum every 5 minutes?
|
|
<KerrickLong> Five minutes? Yeah I can.
|
|
<chromakode> also, can you please add app=mh as an extra param to your api requests? that way we can tell you some interesting stats about its utilization!
|
|
<KerrickLong> chromakode, if I make the orangereds poll /api/me.json instead of /messages/new, could I reduce the interval since it will be a LOT less load?
|
|
<spladug> KerrickLong, /api/me.json would be preferable, but 5 minutes would still be nice. we've seen some crazy high load from shine the last few days and would like to try to avoid having the same issue again</code></pre>
|
|
</blockquote>
|
|
<h2>Why aren’t you using Snoo, the reddit alien, as the icon?</h2>
|
|
<p>The reddit alien logo is a trademark of Conde Nast Digital, and I am required to <a href="http://www.reddit.com/help/licensing">apply for a license to use it</a>. I have done so, and am waiting to hear back. Until then, I cannot use Snoo.</p>
|
|
<h2>What do the default “Excluded Regex” patterns mean?</h2>
|
|
<p>For those that don't speak regular expressions, I'll go over the default Excluded Regex patterns here so you can know which ones to get rid of.</p>
|
|
<pre><code>chrome://.*</code></pre>
|
|
<p>This excludes all Google Chrome pages such as the new tab page, Chrome settings, et. al.</p>
|
|
<pre><code>chrome-extension://.*</code></pre>
|
|
<p>This excludes all Chrome Extension pages such as the Mostly Harmless options page.</p>
|
|
<pre><code>view-source://.*</code></pre>
|
|
<p>This excludes the tabs that open when you view the source code of a web page.</p>
|
|
<pre><code>ftp://.*</code></pre>
|
|
<p>This excludes sites that use the FTP protocol.</p>
|
|
<pre><code>https?://www\.google\.com/search.*</code></pre>
|
|
<p>This excludes Google Search results pages.</p>
|
|
<pre><code>https?://search\.yahoo\.com/search.*</code></pre>
|
|
<p>This excludes Yahoo Search results pages.</p>
|
|
<pre><code>https?://www\.bing\.com/search.*</code></pre>
|
|
<p>This excludes Bing Search results pages.</p>
|
|
<pre><code>https?://www.reddit.com/(?:r/(?:\w|\+)+/?)?(?:$|\?count)</code></pre>
|
|
<p>This excludes the reddit homepage, and the homepage for any subreddit. It also excludes the paginated versions.</p>
|
|
</div>
|
|
<div class="article" id="credits">
|
|
<h2>Dependencies & Libraries</h2>
|
|
<ul>
|
|
<li><a href="http://code.google.com/chrome/extensions/docs.html"><strong>Chrome Extensions</strong>Everything Google Chrome!</a></li
|
|
><li><a href="https://github.com/reddit/reddit/"><strong>Reddit API 1.0</strong>Everything reddit!</a></li
|
|
><li><a href="https://github.com/frankkohlhepp/fancy-settings"><strong>Fancy Settings 1.2</strong>Chrome extension settings</a></li
|
|
><li><a href="https://github.com/frankkohlhepp/store-js"><strong>Store.js 2.3</strong><code>localStorage</code> abstraction</a></li>
|
|
</ul>
|
|
<h2>Authors & Contributors</h2>
|
|
<ul>
|
|
<li><a href="http://www.reddit.com/user/KerrickLong/"><strong>Kerrick Long</strong>Mostly Harmless Creator</a></li
|
|
><li><a href="http://www.reddit.com/user/benjaminmktn121/"><strong>benjaminmktn121</strong>Beta Tester</a></li
|
|
><li><a href="http://www.reddit.com/user/MrArmStrong/"><strong>MrArmStrong</strong>Beta Tester</a></li
|
|
><li><a href="http://www.reddit.com/user/iamfromreallife/"><strong>iamfromreallife</strong>Beta Tester</a></li
|
|
><li><a href="http://www.reddit.com/user/McNerdius"><strong>McNerdius</strong>Beta Tester</a></li
|
|
><li><a href="https://github.com/Kerrick/Mostly-Harmless"><strong>Your Name Here!</strong>Contribute to the project</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="article" id="license">
|
|
<h2>MIT License</h2>
|
|
<blockquote>
|
|
<p>Copyright © 2011 by Kerrick Long</p>
|
|
<p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p>
|
|
<p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p>
|
|
<p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p>
|
|
</blockquote>
|
|
</div>
|
|
</div>
|
|
<span id="guide">Don't Panic</span>
|
|
<script type="text/javascript">
|
|
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
|
|
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
|
|
</script>
|
|
<script type="text/javascript">
|
|
try {
|
|
var pageTracker = _gat._getTracker("UA-18432597-7");
|
|
pageTracker._trackPageview();
|
|
}
|
|
catch (err) {
|
|
}
|
|
</script>
|
|
</body>
|
|
</html> |