Remove repeating text from readme

diff --git a/README b/README
index c3af92d93c50e156c10889eb0d56ef0871459457..b5f5f4f9886b906147146004bde3df87af0fbb76 100644 (file)
--- a/README
+++ b/README
@@ -1,37 +1,8 @@
 == About this library ==
 
-Jenkins is the market leading continuous integration system, originally created by Kohsuke Kawaguchi. This API makes Jenkins even easier to use by providing an easy to use conventional python interface.
+Project source code: github: https://github.com/salimfadhley/jenkinsapi
 
-Jenkins (and It's predecessor Hudson) are fantastic projects - but they are somewhat Java-centric. Thankfully the designers have provided an excellent and complete REST interface. This library wraps up that interface as more conventional python objects in order to make most Jenkins oriented tasks simpler.
+Project documentation: http://packages.python.org/jenkinsapi/
 
-This library can help you:
-
- * Query the test-results of a completed build
- * Get a objects representing the latest builds of a job
- * Search for artefacts by simple criteria
- * Block until jobs are complete
- * Install artefacts to custom-specified directory structures
- * username/password auth support for jenkins instances with auth turned on
- * Ability to search for builds by subversion revision
- * Ability to add/remove/query jenkins slaves
-
-== Installing JenkinsAPI ===
-
-Egg-files for this project are hosted on PyPi. Most Python users should be able to use pip or distribute to automatically install this project.
-
-Most users can do the following:
-
-easy_install jenkinsapi
-
-If you'd like to install in multi-version mode:
-
-easy_install -m jenkinsapi
-
-== Project Authors ==
-
- * Salim Fadhley (sal@stodge.org) 
- * Ramon van Alteren (ramon@vanalteren.nl) 
- * Ruslan Lutsenko (ruslan.lutcenko@gmail.com) 
-
-Current code lives on github: https://github.com/salimfadhley/jenkinsapi
+Releases: http://pypi.python.org/pypi/jenkinsapi
 

diff --git a/doc/source/conf.py b/doc/source/conf.py
index c4e7d2773120d3b5e7a8c7ec80d73edd4ced7f3a..a1b2307e133a94e78a0050cca3b0c99aedb89936 100644 (file)
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -24,6 +24,8 @@ sys.path.insert(0, PROJECT_DIR )
 
 #Sanity check
 import jenkinsapi
+import examples
+import jenkinsapi_tests
 
 # Config file
 import setup_config as jenkinsapi_setup_config

diff --git a/doc/source/index.rst b/doc/source/index.rst
index 6de0b26b113f5933483387bb28d0f351ee4a91f2..e85fdf3cd2cd898a046988a73d63b59b11623de0 100644 (file)
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -16,6 +16,15 @@ This library can help you:
  * Search for builds by subversion revision
  * Add, remove and query jenkins slaves
 
+Important links
+===============
+
+Project source code: github: https://github.com/salimfadhley/jenkinsapi
+
+Releases: http://pypi.python.org/pypi/jenkinsapi
+
+This documentation: http://packages.python.org/jenkinsapi/
+
 Installation
 ============
 
@@ -36,7 +45,7 @@ Project Authors
  * Ramon van Alteren (ramon@vanalteren.nl) 
  * Ruslan Lutsenko (ruslan.lutcenko@gmail.com) 
 
-Current code lives on github: https://github.com/salimfadhley/jenkinsapi
+
 
 Package Contents
 ================

diff --git a/examples/__init__.py b/examples/__init__.py
new file mode 100644 (file)
index 0000000..e69de29