Permalink
Browse files

updated documentation

  • Loading branch information...
1 parent 2732837 commit e0cdb774d8a6b38885f96b290059eeab8464a93a @hvelarde hvelarde committed Apr 11, 2012
Showing with 74 additions and 79 deletions.
  1. +34 −17 README.rst
  2. +25 −19 docs/HISTORY.txt
  3. +15 −43 docs/INSTALL.txt
View
@@ -1,37 +1,54 @@
-Introduction
-============
+===========================
+collective.twitter.accounts
+===========================
-This product allows you to add twitter accounts to a Plone site.
+.. contents:: Table of Contents
+
+Overview
+--------
+
+This product allows you to add Twitter_ accounts to a Plone site.
It uses oAuth authentication.
Usage
-=====
+-----
- Go to the "Site Setup", then to the "Twitter" tool.
-- Choose wether to use Plone's default twitter application (PloneTweet) or a custom one.
-- If you choose to use a custom Twitter application, enter your consumer key and secret for it
-- Click on "Request twitter token"
-- A new link should've appeared below "Allow permission to your account". Click it in order to allow the app to use your Twitter account
+- Choose wether to use Plone's default twitter application (PloneTweet) or a
+ custom one.
+- If you choose to use a custom Twitter application, enter your consumer key
+ and secret for it.
+- Click on "Request Twitter token".
+- A new link should've appeared below "Allow permission to your account".
+ Click it in order to allow the app to use your Twitter account.
- Copy the given token into the "Token" input field.
-- Click "Add"
-- If something went wrong, you need to click on "Request twitter token" and the following link to get a new token and try again.
+- Click "Add".
+- If something went wrong, you need to click on "Request Twitter token" and
+ the following link to get a new token and try again.
Done.
-If you want to remove an account, simply click on its red cross next to its name.
-Be carefull, it will delete the account without confirmation, and it cannot be undone.
+If you want to remove an account, simply click on its red cross next to its
+name. Be carefull, it will delete the account without confirmation, and it
+cannot be undone.
Twitter Applications
-====================
+--------------------
-In order to allow external access to a twitter account, you need to register an "Application" in https://dev.twitter.com/
-There's already a "PloneTweet" application registered that can be used, but if you want to use your own, just regiter it there.
+In order to allow external access to a twitter account, you need to register
+an "Application" in https://dev.twitter.com/ There's already a "PloneTweet"
+application registered that can be used, but if you want to use your own, just
+regiter it there.
Actually posting or getting to/from Twitter
-===========================================
+-------------------------------------------
This product just saves the needed data in order to post tweets or read them.
-You'll need additional products in order to do so, for example http://pypi.python.org/pypi/collective.twitter.action
+You'll need additional products in order to do so, for example
+`collective.twitter.action`_ or `collective.twitter.portlets`_.
+.. _`collective.twitter.action`: http://pypi.python.org/pypi/collective.twitter.action
+.. _`collective.twitter.portlets`: http://pypi.python.org/pypi/collective.twitter.portlets
+.. _Twitter: http://twitter.com/
View
@@ -1,20 +1,26 @@
Changelog
-=========
-
-dev
----
- * Moved to GitHub [frapell]
- * Refactored the package to give its own dev/test buildout [frapell]
- * Separated profiles for initial and default [frapell]
- * Added an uninstall profile [frapell]
- * Added some tests [frapell]
- * Improved usability with a pop-up to authorize app [frapell]
-
-1.0.1
------
- * Added spanish internationalization [frapell]
-
-1.0.0
------
- * Created a configlet to add and remove twitter accounts [frapell]
- * Initial release
+---------
+
+1.0.2 (unreleased)
+^^^^^^^^^^^^^^^^^^
+
+- Moved to GitHub. [frapell]
+- Refactored the package to give its own dev/test buildout. [frapell]
+- Separated profiles for initial and default. [frapell]
+- Added an uninstall profile. [frapell]
+- Added some tests. [frapell]
+- Improved usability with a pop-up to authorize app. [frapell]
+
+
+1.0.1 (2011-07-26)
+^^^^^^^^^^^^^^^^^^
+
+- Added spanish internationalization [frapell]
+
+
+1.0.0 (2011-07-25)
+^^^^^^^^^^^^^^^^^^
+
+- Created a configlet to add and remove twitter accounts. [frapell]
+- Initial release.
+
View
@@ -1,52 +1,24 @@
-collective.twitter.accounts Installation
--------------------------------
+Installation
+------------
-To install collective.twitter.accounts into the global Python environment (or a workingenv),
-using a traditional Zope 2 instance, you can do this:
+To enable this product in a buildout-based installation:
-* When you're reading this you have probably already run
- ``easy_install collective.twitter.accounts``. Find out how to install setuptools
- (and EasyInstall) here:
- http://peak.telecommunity.com/DevCenter/EasyInstall
-
-* If you are using Zope 2.9 (not 2.10), get `pythonproducts`_ and install it
- via::
-
- python setup.py install --home /path/to/instance
-
-into your Zope instance.
-
-* Create a file called ``collective.twitter.accounts-configure.zcml`` in the
- ``/path/to/instance/etc/package-includes`` directory. The file
- should only contain this::
-
- <include package="collective.twitter.accounts" />
-
-.. _pythonproducts: http://plone.org/products/pythonproducts
-
-
-Alternatively, if you are using zc.buildout and the plone.recipe.zope2instance
-recipe to manage your project, you can do this:
-
-* Add ``collective.twitter.accounts`` to the list of eggs to install, e.g.:
+1. Edit your buildout.cfg and add ``collective.twitter.accounts`` to the list
+ of eggs to install ::
[buildout]
...
eggs =
- ...
collective.twitter.accounts
-
-* Tell the plone.recipe.zope2instance recipe to install a ZCML slug:
- [instance]
- recipe = plone.recipe.zope2instance
- ...
- zcml =
- collective.twitter.accounts
-
-* Re-run buildout, e.g. with:
+After updating the configuration you need to run ''bin/buildout'', which will
+take care of updating your system.
+
+Go to the 'Site Setup' page in a Plone site and click on the 'Add-ons' link.
+
+Check the box next to ''collective.twitter.accounts'' and click the
+'Activate' button.
+
+Note: You may have to empty your browser cache and save your resource
+registries in order to see the effects of the product installation.
- $ ./bin/buildout
-
-You can skip the ZCML slug if you are going to explicitly include the package
-from another package's configure.zcml file.

0 comments on commit e0cdb77

Please sign in to comment.