Permalink
Browse files

[#1,README][s]: rewrite README to reflect current setup and merge CHA…

…NGELOG with README.
  • Loading branch information...
1 parent bc2def6 commit cea35b7ef424884d594b50486afcd6e816f1e714 @rufuspollock rufuspollock committed Feb 12, 2012
Showing with 66 additions and 73 deletions.
  1. +0 −31 CHANGELOG.txt
  2. +66 −0 README.md
  3. +0 −42 README.txt
View
@@ -1,31 +0,0 @@
-HEAD
-====
-
-v0.6.1 2011-02-22
-=================
-
-* Minor tweak to CC by-sa license name
-
-v0.6 2011-02-11
-===============
-
-* Heavy refactoring and simplification
-* Improve and add documentation
-
-v0.5 2010-05-11
-===============
-
-* Addition of Licenses SoS v2.0 capabilities
-
-
-v0.4 2010-03-08
-===============
-
-* This module is redesigned to be a web service
-* Addition of Licenses SoS v1.0 capabilities (Specification of Service)
-
-
-v0.3 2010-03-06 and older
-=========================
-
-* Module is designed to be imported to provide its list of licenses
View
@@ -0,0 +1,66 @@
+Machine readable list of open (http://opensource.org/,
+http://opendefinition.org/) licenses and web service - see
+<http://licenses.opendefinition.org/>.
+
+Layout:
+
+<pre>
+README.md
+index.html # home page
+datapackage.json # data package info
+licenses/{id}.json # json versions of licenses
+licenses/{id}.json.js # jsonp
+bin/ # scripts
+</pre>
+
+Note: jsonp versions are only created as part of the build and deploy process
+for the service.
+
+## Build and Deployment
+
+To build files for deployment do:
+
+ bin/deploy.py
+
+For deployment simply upload the current directory files to a relevant online
+location.
+
+We currently, use github pages (but previously used s3).
+
+## Changelog
+
+HEAD
+====
+
+* Complete rewrite to be simpler (just data, no longer python library).
+ See <https://github.com/okfn/licenses/issues/1>
+
+v0.6.1 2011-02-22
+=================
+
+* Minor tweak to CC by-sa license name
+
+v0.6 2011-02-11
+===============
+
+* Heavy refactoring and simplification
+* Improve and add documentation
+
+v0.5 2010-05-11
+===============
+
+* Addition of Licenses SoS v2.0 capabilities
+
+
+v0.4 2010-03-08
+===============
+
+* This module is redesigned to be a web service
+* Addition of Licenses SoS v1.0 capabilities (Specification of Service)
+
+
+v0.3 2010-03-06 and older
+=========================
+
+* Module is designed to be imported to provide its list of licenses
+
View
@@ -1,42 +0,0 @@
-A list of open (http://opensource.org/, http://opendefinition.org/) licenses
-together with API and web service.
-
-How to use the Licenses Package
-===============================
-
-This package can be used in three ways (develop, distribute, and deploy).
-
-1. To create and access license data in JSON form.
-
- The package contains a data file (./licenses/licenses.db) and a scraper
- (licenses/scrape.py) which and updates the data file::
-
- $ hg clone https://bitbucket.org/okfn/licenses
- $ cd licenses
- $ python licenses/scrape.py
-
- A report will be printed about changes to the licenses data.
-
-
-2. Access of the data via a simple python API::
-
- >>> from licenses import Licenses
- >>> L = Licenses()
- >>> for l in L: print l
- ...
- odc-odbl
- ...
- >>> print l['odb-odbl']
- {'status': 'active', ...
- >>>
-
-
-3. Deployment as a service.
-
- Install or update the Python package, then create the service files::
-
- $ python licenses/deploy.py <path>
-
- A whole set of files will be created at <path> which can then be served
- directly by your webserver.
-

0 comments on commit cea35b7

Please sign in to comment.