From 5d7d4c5e20eed1da031ba4e0aa9aedfd5ad08274 Mon Sep 17 00:00:00 2001 From: Craig Oates Date: Fri, 2 Jul 2021 19:24:33 +0100 Subject: [PATCH] update README. --- README.md | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 05cb23b..8255344 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Ritherdon REST A package which grabs data from the [Return to -Ritherdon[(http://ritherdon.abbether.net/) project's REST API server. +Ritherdon](http://ritherdon.abbether.net/) project's REST API server. The intended way to use this code is within a Lisp REPL -- something like SLIME in Emacs or Steel Bank Common Lisp (SBCL). If they do not @@ -121,8 +121,8 @@ To load the system via ASDF, enter the following into SBCL or SLIME, (ritherdon-rest:parse-request "/status/latest/1") ;;; The 'ritherdon-rest.asd' file has connected the test system to the -main system. So you can run the tests from the main system. In other -words, to run the tests, +;;; main system. So you can run the tests from the main system. In other +;;; words, to run the tests, (asdf:test-system :ritherdon-rest) ;Instead of ':ritherdon-rest/tests'. ``` If you are making repeated calls and want to reduce the amount of @@ -133,7 +133,7 @@ and call its functions directly. ;;; This removes the need to type the 'ritherdon-rest:' part all the time. (in-package :ritherdon-rest) (parse-request "/status/latest") -(parse-request "/reading/latest/2) +(parse-request "/reading/latest/2") (parse-request "reading/all/1") ;;; To return to the default package, @@ -145,15 +145,19 @@ and call its functions directly. This repository is to help me learn Common Lisp. Because of this, there is no Issue Tracker, Wiki or Requests section. I have made this repository public on the off-chance is might help you learning about -Common Lisp. +Common Lisp by seeing something in-situ. -The Return to Ritherdon API has HTTP-Push requests. I have not -provided any functions to make these types of requests because I do -not want to run the risk of breaking that system. The API is part of -an active art exhibition and I do not want to corrupt the data it -stores/created in any way. +The [Return to Ritherdon API](http://ritherdon.abbether.net/api/ui/) +has HTTP-Push requests. I have not provided any functions to make +these types of requests because I do not want to run the risk of +breaking that system. The API is part of an active art exhibition and +I do not want to corrupt the data it stores/created in any way. I have ran this project on Linux and nothing else. I have no idea if this work on Windows or MacOS. I, also, have no urge to find out. Unfortunately, you are on your own here because I have no means to test it. + +As stated near the top of this document, I am expecting to shutdown +the API near the end of 2021. When that happens, this will remain as a +reference repository.