Permalink
Browse files

Updated readme for Lessn More 2.0, also mentioned bookmarklets and ne…

…w home page and repo
  • Loading branch information...
alanhogan committed Feb 26, 2010
1 parent 4667919 commit e5838b1c73bab24cbeffa5e2880217f71e56c5b5
Showing with 66 additions and 20 deletions.
  1. +66 −20 README.md
View
@@ -1,14 +1,46 @@
-Lessn More
-==========
+Lessn More 2.0
+==============
-Lessn is an extremely simple, personal url shortener
- written in PHP with MySQL and mod_rewrite
- by Shaun Inman <http://shauninman.com/>.
+Homepage: <http://lessnmore.net>
+Source/Fork: <http://github.com/alanhogan/lessmore>
-Buttered URLs is a fork of Lessn by Jeremy Knope <http://github.com/jfro>.
+Lessn More is a personal url shortener.
+
+Features:
+
+* The ability to use custom short URLs (slugs), unlike Lessn
+* A bookmarklet that even supports custom short URLs
+* An API that supports the same commands as the web interface
+* Different auto-shorten modes (optional mixed case),
+* The ability to avoid lookalike characters, and
+* An optional "banned word list" to prevent auto-generating offensive URLs.
+* Support for more shortened URLs than Lessn
+* The ability to add multiple slugs that point to the same long URL, unlike Lessn
+
+Attention to detail:
-Lessn More is a fork of Buttered URLs
- by Alan Hogan <http://github.com/alanhogan>.
+* Adding a new slug for a URL already in the database will become the "canonical"
+ short URL, and will be returned if you ask Lessn More (either by API or not)
+ for a short URL to the original resource
+* Amazingly, Lessn More lets you change the character set you want to use
+ to generate short URLs on-the-fly, and yet the insertion algorithm
+ is fast. (Not as fast as Lessn 1.0, by necessity, since Lessn 1.0 did not allow
+ custom short URLs; but the worst-case insertion time after
+ upgrade or a switch of insertion algorithms is on the order of O(log(n)) where
+ <var>n</var> is the number of redirections in your database, and the common case is
+ on the order of O(1) (constant time).)
+
+An easy migration script will upgrade your database
+from an existing Lessn migration.
+
+
+Requirements
+-------------
+
+* PHP 5.1+
+* PHP's PDO
+* MySQL, PostgreSQL, or SQLite
+* mod_rewrite or similar rewrite system (see .htaccess)
<!--
This document is written in Markdown,
@@ -19,17 +51,32 @@ Lessn More is a fork of Buttered URLs
(TextMate: ⌃⌥⌘-P to preview as web page)
-->
-Lessn is offered as-is, sans support and without warranty.
-Copyright © 2009-10 Shaun Inman and contributors.
+History
+-------
+### v1.0
-Requirements
--------------
+Lessn was the original personal URL shortening service,
+written by Shaun Inman <http://shauninman.com/>. It required PHP, MySQL, and mod_rewrite.
-* PHP 5.1+
-* PHP's PDO
-* MySQL or PostgreSQL or SQLite
-* mod_rewrite or similar rewrite system (see .htaccess)
+### v1.1
+
+Buttered URLs is a fork of Lessn by Jeremy Knope <http://github.com/jfro>.
+Buttered URLs added logging, custom URLs, migration mechanism, and support for more database types.
+
+### v2.0
+
+Lessn More is a fork of Buttered URLs by Alan Hogan <http://github.com/alanhogan>.
+Lessn More increased the robustness and flexibility of the insertion algorithm,
+prevented slug conflicts, updated the bookmarklets, added multiple auto-shorten modes,
+banned word lists, and enhanced security.
+
+
+Legal
+-----
+
+Lessn is offered as-is, sans support and without warranty.
+Copyright © 2009-10 Shaun Inman and contributors.
Installation
@@ -51,10 +98,10 @@ Installation instructions are different depending on if you are upgrading or doi
directory to your domain's root public folder.
(For short urls when that is not possible,
upload the entire directory to your server
- and rename to a single character.
+ and rename to a single character or so.
Example: http://doma.in/x/)
-3. Visit http://doma.in/-/ log in & start using!
+3. Visit http://doma.in/-/ to log in & start using Lessn More!
Be sure to grab the bookmarklets. (The required database table is created
automatically the first time you visit Lessn).
@@ -85,7 +132,6 @@ If you are upgrading from a previous version of Lessn or ButteredURLs:
N is 4 if upgrading from ButteredURLs 1.1.
1. Test some old known working redirections
1. Delete install.php.
-
-<!-- Upgrading to LessnMore 2.1+ from ≤ 2.0 should start at install.php?start=4. -->
+1. Grab the new bookmarklets with custom short URL support!
**Congratulations.** You are running the latest version of Lessn More.

0 comments on commit e5838b1

Please sign in to comment.