From 1fdb35bbf105fe462dcc663ea20b6aa56d654001 Mon Sep 17 00:00:00 2001
From: Zach Copley <zach@controlyourself.ca>
Date: Fri, 20 Feb 2009 17:17:20 -0800
Subject: New doc page for Identi.ca badge and minor updates to badge's js

---
 doc-src/badge | 65 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 65 insertions(+)
 create mode 100644 doc-src/badge

(limited to 'doc-src/badge')

diff --git a/doc-src/badge b/doc-src/badge
new file mode 100644
index 000000000..1c368eb69
--- /dev/null
+++ b/doc-src/badge
@@ -0,0 +1,65 @@
+Install the %%site.name%% badge on you blog or web site to show the latest updates 
+from you and your friends!
+
+<MTMarkdownOptions output='raw'>
+<script type="text/javascript" src="http://identi.ca/js/identica-badge.js">
+{
+   "user":"kentbrew",
+   "server":"identi.ca",
+   "headerText":" and friends"
+}
+</script>
+</MTMarkdownOptions>
+
+Things to try
+--------------
+
+* Click an avatar and the badge will refresh with that user's timeline
+* Click a nickname to open a user's profile in your browser
+* Click a notice's timestamp to view the notice in your browser
+* @-replies and #tags are live links
+
+## Installation instructions 
+
+Copy and paste the following JavaScript into an HTML page where
+you want the badge to show up.  Substitute your own ID in the user
+parameter.
+
+<pre>
+	&lt;script type=&quot;text/javascript&quot; src=&quot;http://identi.ca/js/identica-badge.js&quot;&gt;
+	{
+	   &quot;user&quot;:&quot;kentbrew&quot;,
+	   &quot;server&quot;:&quot;identi.ca&quot;,
+	   &quot;headerText&quot;:&quot; and friends&quot;
+	}
+	&lt;/script&gt;
+
+</pre>
+
+
+
+Valid parameters for the badge:
+-------------------------------
+
+* user : defaults to 7000 (@kentbrew)
+* headerText  : defaults to empty
+* height : defaults to 350px
+* width : defaults to 300px
+* background : defaults to #193441. If you set evenBackground, oddBackground,
+  and headerBackground, you won't see it at all.
+* border : defaults to 1px solid black
+* userColor : defaults to whatever link color is set to on your page
+* headerBackground : defaults to transparent 
+* headerColor :  defaults to white
+* evenBackground : defaults to #fff
+* oddBackground : defaults to #eee
+* thumbnailBorder : 1px solid black
+* thumbnailSize : defaults to 24px
+* padding : defaults to 3px
+* server : defaults to identi.ca
+
+Licence
+-------
+
+Identi.ca badge by [Kent Brewster](http://kentbrewster.com/identica-badge/). 
+Licenced under [CC-BY-SA-3](http://kentbrewster.com/rights-and-permissions/).
-- 
cgit v1.2.3-54-g00ecf