Skip to content

Commit

Permalink
Update the README
Browse files Browse the repository at this point in the history
  • Loading branch information
pilhuhn committed Sep 29, 2013
1 parent 3221437 commit 74440b8
Showing 1 changed file with 25 additions and 15 deletions.
40 changes: 25 additions & 15 deletions README → README.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
= Welcome to Zwitscher

Welcome to Zwitscher, a microblogging client for Android, that is licensed
under the ASL V2 license (as is Twitter4j) -- see LICENSE.txt
I know that this is not the first one and far from working good.
Expand All @@ -22,35 +24,42 @@ to help translating into new languages, ping me.
If you find issues or want new features, please open
an issue on the github tracker at https://github.com/pilhuhn/ZwitscherA/issues

===== ATTENTION ON HACKING THE SOURCE =========
== ATTENTION ON HACKING THE SOURCE

As Twitter.com is not really ready to handle open source projects,
you need to register the app at Twitter and then provide a class
Token (renamed from TwitterConsumerToken) that looks like this with the values Twitter
provided you with put in:

package de.bsd.zwitscher;
[source,java]
----
package de.bsd.zwitscher;
public class Tokens {
public class Tokens
{
public static String consumerKey = "replaceWithKey";
public static String consumerSecret = "replaceWithSecret";
public static boolean xAuthEnabled = false;
public static String consumerKey = "replaceWithKey";
public static String consumerSecret = "replaceWithSecret";
public static boolean xAuthEnabled = false;
public static final String readItLaterToken = "";
public static final String readItLaterToken = "";
public static String tweetMarkerToken = "";
public static String tweetMarkerToken = "";
}
public static String bugSenseKe = "";
}
----

To obtain this Token, go to http://twitter.com/apps and log in.
To obtain these Twittter-Tokens, go to http://twitter.com/apps and log in.
Then click on "Register an Application" and give some details.
When this is done you will end up on a page that lists application
details including consumerKey and consumerSecret.
details including `consumerKey` and `consumerSecret`.
As Twitter by default does not enable xAuth, the third parameter
needs to be set to false to go through the "normal" oAuth procedure of
needs to be set to `false` to go through the "normal" oAuth procedure of
logging in.

Zwitscher has meanwhile progressed enough to be available on the Android market.
For this version you don't need to obtain any tokens.

== Support for ReadItlater (http://http://readitlaterlist.com/)

Expand All @@ -64,9 +73,10 @@ Zwitscher can now also sync last read information with
TweetMarker.com (and thus with clients like Twitterriffic).
To enable this, you also need to have a token in above tokens file

== Support for BugSense

If you supply a token value for bugSense, BugSense crash reporting
is turned on.

==========================

Zwitscher has meanwhile progressed enough to be available on the Android market.
For this version you don't need to obtain any tokens.

0 comments on commit 74440b8

Please sign in to comment.