Added readme
authorDaniel Davis <ddavis@w3.org>
Fri, 30 Aug 2013 18:29:56 +0900
changeset 7 f99dee75e0ce
parent 6 393375e18d7a
child 8 baec633d179a
child 10 d5e89a824e6b
Added readme
README
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Fri Aug 30 18:29:56 2013 +0900
@@ -0,0 +1,36 @@
+= W3C_talks =
+
+== Description ==
+
+A script for automatically posting slide notes to Twitter as you give a presentation. Wow the crowd with your magic tweets!
+
+== Requirements ==
+
+W3C_talks should work in all modern browsers including IE 8.
+It currently works with the following HTML presentation templates:
+* Slidy - http://www.w3.org/Talks/Tools/Slidy2/Overview.html
+* Shower - http://shwr.me/
+
+== Instructions ==
+
+To use, you should do the following things:
+# Include the `w3c_talks.js` script in your presentation HTML file, preferably at the end of the body, like so:
+    ...
+    <script src="js/w3c_talks.js"></script>
+    </body>
+# Add metatags for the author, event hashtag and access key, like so:
+    <meta name="author" content="Mr Bean">
+    <meta name="hashtag" content="#teddyconf2013">
+    <meta name="accesskey" content="abcd1234">
+# Finally put any notes in `data-note` attributes for your chosen slides, like so:
+    <div class="slide" data-note="Teddy bears celebrated their 100th birthday in 2002">
+        <h1>How old are teddy bears?</h1>
+        
+        <p>Teddies celebrated their 100th birthday in 2002</p>
+    </div>
+
+That's it. When you show each slide, any notes you have added will be tweeted to [https://twitter.com/w3c_talks @w3c_talks].
+
+== Support ==
+
+W3C_talks is a group effort by Hiroto Yahagi, Renoir Boulanger and Daniel Davis. If you have any suggestions, questions or problems please contact Daniel at [email protected] or @ourmaninjapan on Twitter.