changeset 11:a4560f329a9e

added readme
author Radomir Dopieralski <sheep-devel@sheep.art.pl>
date Sat, 14 May 2011 00:57:13 +0200
parents 2f5f4963d09e
children a51909f8032d
files README.txt hgstorage.py
diffstat 2 files changed, 8 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.txt	Sat May 14 00:57:13 2011 +0200
@@ -0,0 +1,3 @@
+This is a simple library that lets you store versioned strings in a Mercurial
+repository. It should be suitable for use in Mercurial-based web applications
+such as wiki engines.
--- a/hgstorage.py	Sat May 14 00:32:05 2011 +0200
+++ b/hgstorage.py	Sat May 14 00:57:13 2011 +0200
@@ -1,14 +1,18 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
+"""
+A persistent, versioned, string storage based on a Mercurial repository.
+"""
+
 import os
 import thread
 import urllib
 import datetime
 import weakref
 
+# This needs to be defined before importing Mercurial
 os.environ['HGENCODING'] = 'utf8'
-os.environ['HGMERGE'] = "internal:merge"
 
 import mercurial.hg
 import mercurial.ui