diff --git a/README.rst b/README.rst index 289fba3..e62d772 100644 --- a/README.rst +++ b/README.rst @@ -19,18 +19,38 @@ This is going to be awesome, and modeled after the excellent github2 module. Usage ----- -Hmm.. :: + >>> from convore.client import ConvoreClient + >>> convore = ConvoreClient('username', 'password') + + >>> groups = convore.groups() + >>> groups + [>> topics = groups[0].topics() + >>> topics + [>> len(topics) + 14 - >>> from convore import Convore - >>> convore = Convore('username', 'password') - - >>> concore.groups - [, ...] - - convore.groups[id] ? - - convore.groups.create(name, decription=None, slug=None) + >>> messages = topics[0].messages() + >>> messages + [>> new_topic = groups[0].topics.create(name="New Topic") + >>> new_topic + >> new_topic.messages.create(message="The first message") + >>> new_topic.messages.create(message="The 2nd one") + >>> len(new_topic.messages()) + 2 + + >>> convore.groups['292'] + >> convore.groups.create(name, decription=None, slug=None) + (group creation doesn't work at this moment..)