Commits

Nikhil Marathe committed e6fc94d

Moved README and marked it as markdown to get bitbucket to render

  • Participants
  • Parent commits 59b1ba8

Comments (0)

Files changed (2)

+-*- markdown -*-
+
+newLISP-redis
+=============
+
+newLISP-redis allows newLISP scripts to access the (http://code.google.com/p/redis)[Redis] key-value store.
+
+Build
+-----
+Just drop the redis.lsp file into your working directory or directly invoke it with
+
+    (load "/path/to/newlisp-redis/redis.lsp")
+
+To generate documentation just run
+
+    make
+
+or `newlispdoc redis.lsp`
+
+Usage
+-----
+
+1) Load the module
+
+    (load "/path/to/newlisp-redis/redis.lsp")
+
+2) Create a connection
+
+    (setf 'conn (redis))
+
+3) Call commands
+
+    (:ping conn) => "PONG"
+    (:set "key" "value") => "OK"
+    (:del "key") => 1
+
+newLISP-redis will aim to have one-to-one mappings to (http://code.google.com/p/redis/wiki/CommandReference)[Redis commands], so you can invoke any command with the same arguments that Redis accepts.
+
+Since the commands themselves are automatically generated they don't have documentation.
+
+Commands return values in the newLISP equivalent types:
+
+    status code replies => string
+    error reply => string
+    integer reply => integer
+    bulk reply => string
+    multi-bulk reply => list ( Redis sets are returned as lists too )
+

File README.md

-newLISP-redis
-=============
-
-newLISP-redis allows newLISP scripts to access the (http://code.google.com/p/redis)[Redis] key-value store.
-
-Build
------
-Just drop the redis.lsp file into your working directory or directly invoke it with
-
-    (load "/path/to/newlisp-redis/redis.lsp")
-
-To generate documentation just run
-
-    make
-
-or `newlispdoc redis.lsp`
-
-Usage
------
-
-1) Load the module
-
-    (load "/path/to/newlisp-redis/redis.lsp")
-
-2) Create a connection
-
-    (setf 'conn (redis))
-
-3) Call commands
-
-    (:ping conn) => "PONG"
-    (:set "key" "value") => "OK"
-    (:del "key") => 1
-
-newLISP-redis will aim to have one-to-one mappings to (http://code.google.com/p/redis/wiki/CommandReference)[Redis commands], so you can invoke any command with the same arguments that Redis accepts.
-
-Since the commands themselves are automatically generated they don't have documentation.
-
-Commands return values in the newLISP equivalent types:
-
-    status code replies => string
-    error reply => string
-    integer reply => integer
-    bulk reply => string
-    multi-bulk reply => list ( Redis sets are returned as lists too )
-