Skip to content

Commit

Permalink
Readme update for 1.4.1
Browse files Browse the repository at this point in the history 
git-svn-id: http://yourls.googlecode.com/svn/trunk@288 12232710-3e20-11de-b438-597f59cd7555
  • Loading branch information
@ozh
ozh committed Mar 4, 2010
1 parent 732fbfd commit 39ad852
Showing 1 changed file with 27 additions and 11 deletions.
38 changes: 27 additions & 11 deletions readme.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ <h3>YOURLS Features</h3>
<li>Handy <tt>bookmarklet</tt> to easily shorten and share links</li>
<li>Awesome <tt>stats</tt>: historical click reports, referrers tracking, visitors geo-location</li>
<li>Neat <tt>AJAXed</tt> interface</li>
<li>Developer <tt>API</tt></li>
<li>Cool developer <tt>API</tt></li>
<li>Friendly <tt>installer</tt></li>
</ul>

Expand Down Expand Up @@ -267,6 +267,13 @@ <h2>Fresh Install</h2>
<li>Point your browser to <code>http://yoursite.com/admin/</code></li>
</ol>

<h2>Upgrade from YOURLS 1.4</h2>
<ol>
<li>Unzip the YOURLS archive</li>
<li>Upload files to your server, overwriting your existing install</li>
<li>Point your browser to <code>http://yoursite.com/admin/</code></li>
</ol>

<h2>Upgrade from YOURLS 1.3 or earlier</h2>
<ol>
<li>Make a copy of your <code>config.php</code></li>
Expand All @@ -277,7 +284,6 @@ <h2>Upgrade from YOURLS 1.3 or earlier</h2>
<li><strong>Backup the database!</strong></li>
<li>Point your browser to <code>http://yoursite.com/admin/</code> and follow instructions</li>
<li>After upgrade is well and over, remove the define <code>YOURLS_DB_TABLE_NEXTDEC</code> from your config file</li>
<li>I promise that during next upgrade you won't need to touch your config file again :)</li>
</ol>

</div>
Expand Down Expand Up @@ -313,7 +319,7 @@ <h3>Site options</h3>
Timezone GMT offset<br/>
<em>Example:</em> <tt>'-5'</tt></li>
<li><code>YOURLS_PRIVATE</code><br/>
Private means protected with login/pass as defined below. Set to false for public usage<br/>
Private means protected with login/pass as defined below. Set to false for public usage (on an intranet for instance)<br/>
<em>Example:</em> <tt>'true'</tt></li>
<li><code>YOURLS_UNIQUE_URLS</code><br/>
Allow multiple short URLs for a same long URL<br/>
Expand Down Expand Up @@ -361,6 +367,7 @@ <h2>WordPress Plugin</h2>
<h3>Features</h3>
<ul>
<li>Generate short URLs for each new post or page</li>
<li>Generate short URLs for all your old posts and pages if wished</li>
<li>Send a tweet on your Twitter account with the post title and short URL as you publish them</li>
<li>Works if YOURLS is hosted on the same server or on a remote server</li>
<li>Also compatible with tr.im, is.gd, tinyurl.com and bit.ly for maximum fun</li>
Expand Down Expand Up @@ -388,14 +395,14 @@ <h3>Features</h3>
<li>Generate or get existing short URLs, with sequential or custom keyword</li>
<li>Get some statistics about your links: top clicked links, least clicked links, newest links</li>
<li>Output format: JSON, XML, or simple raw text</li>
<li>Authentify either with login/password or using a secure passwordless mechanism</li>
</ul>

<h3>Usage</h3>
<p>You need to send parameters to <code>http://yoursite.com/yourls-api.php</code> either via <code>GET</code> or <code>POST</code>. These parameters are:</p>
<ul>
<li>A valid <code>username</code></li>
<li>A valid <code>password</code></li>
<li>The requested <code>action</code>: <tt>"shorturl"</tt> (get short URL for a link), <tt>"expand"</tt> (get long URL of a shorturl) or <tt>"stats"</tt> (get stats about your links)</li>
<li>A valid <code>username</code> / <code>password</code> pair, or your <code>signature</code> (see <a href="http://code.google.com/p/yourls/wiki/PasswordlessAPI">Passwordless API requests</a>)</li>
<li>The requested <code>action</code>: <tt>"shorturl"</tt> (get short URL for a link), <tt>"expand"</tt> (get long URL of a shorturl), <tt>"url-stats"</tt> (get stats about one short URL) or <tt>"stats"</tt> (get stats about your links)</li>
<li>With <tt>action = "shorturl"</tt> :
<ul>
<li>the <code>url</code> to shorten</li>
Expand All @@ -409,6 +416,12 @@ <h3>Usage</h3>
<li>output <code>format</code>: either <tt>"json"</tt>, <tt>"xml"</tt> or <tt>"simple"</tt></li>
</ul>
</li>
<li>With <tt>action = "url-stats"</tt> :
<ul>
<li>the <code>shorturl</code> for which to get stats (can be either 'abc' or 'http://site/abc')</li>
<li>output <code>format</code>: either <tt>"json"</tt> or <tt>"xml"</tt></li>
</ul>
</li>
<li>With <tt>action = "stats"</tt> :
<ul>
<li>the <code>filter</code>: either <tt>"top"</tt>, <tt>"bottom"</tt> , <tt>"rand"</tt> or <tt>"last"</tt></li>
Expand Down Expand Up @@ -467,8 +480,7 @@ <h3>Difference Between Base 36 And Base 62 Encoding</h3>
<li>Base 36 encoding uses <code>0123456789abcdefghijklmnopqrstuvwxyz</code></li>
<li>Base 62 encoding uses <code>0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz</code></li>
<li>Stick to one setting, don't change after you've created links as it will change all your short URLs!</li>
<li>Base 36 should be picked. Use 62 only if you understand what it implies.</li>
<li>Consider Base 62 encoding a <code>beta feature</code></li>
<li>Base 36 is the default and should be picked.</li>
</ul>

<h3>Getting a short domain name for your YOURLS install</h3>
Expand All @@ -487,12 +499,13 @@ <h3>YOURLS needs its own .htaccess</h3>
<h3>If YOURLS generates 404 for your short URLs</h3>
<ul>
<li>Make sure <strong>mod_rewrite</strong> is enabled with your Apache server</li>
<li>Some (crappy) hosts such as GoDaddy or 1and1 need <a href="http://code.google.com/p/yourls/issues/detail?id=25">a small fix</a> to .htaccess:</li>
<li>Some (crappy) hosts such as GoDaddy or 1and1 need <a href="http://code.google.com/p/yourls/issues/detail?id=25">a small fix</a> to .htaccess</li>
</ul>

<h3>Feedback and bug reporting</h3>
<h3>Feedback, feature requests and bug reporting</h3>
<ul>
<li>Please don't get in touch directly by mail or Twitter</li>
<li>Please don't get in touch directly by mail or Twitter. <a href="http://yourls.org/support">Please</a>.</li>
<li>Check the <a href="http://code.google.com/p/yourls/wiki/RoadMap">Road Map</a> for future features</li>
<li>Raise an <a href="http://yourls.org/issues">issue here</a> and give all the details. Thanks!</li>
</ul>

Expand Down Expand Up @@ -546,6 +559,9 @@ <h2>More stuff about or with YOURLS</h2>
<li><a href="http://www.eugenegordin.com/etc/how-to-use-your-custom-yourls-shortener-with-tweetie-2.html">YOURLS and Tweetie 2</a><br/>
How to set up Tweetie2 so it uses your own service</li>

<li><a href="http://www.mrtech.com/forums/index.php/topic,2524.0.html">YOURLS hacks</a><br/>
How to enhance YOURLS for spam control/throttling, unshortening and weekly stats

<li><a href="http://code.google.com/p/yourls/issues/detail?id=137">Export URLS as text list</a><br/>
A simple script to list all URLs, one per line, in plain text (for using as an indexer config file, for example)</li>

Expand Down

0 comments on commit 39ad852

Please sign in to comment.