Commits

Joris Kluivers committed e8a0fe2

Initial readme file

Comments (0)

Files changed (1)

+# Microtext
+
+A twitter-text-java port to Go. Enables you to extract and optionally autolink URL's in text.
+
+## Features
+
+- extract URL's
+- autolink URL's in text
+- display URL's shortened instead of full url
+
+Mentions & hashtags are not implemented.
+
+## Example
+
+    import (
+        "kluivers/microtext"
+    )
+    
+    text = Autolink(text)
+
+## What's in the name
+
+The name `microtext` refers to the text processing in status updates for `microblogs`.
+
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.