From f6e2215acee2126f75d611fda56242c4b7437c92 Mon Sep 17 00:00:00 2001 From: Yuchen Pei Date: Tue, 24 Oct 2023 23:38:30 +1100 Subject: Updating readme to include instructions using bom as an emacs package --- README.org | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) diff --git a/README.org b/README.org index 376d697..5f79f23 100644 --- a/README.org +++ b/README.org @@ -3,7 +3,7 @@ * Introduction :PROPERTIES: - :UPDATED: [2023-10-08 Sun 15:47] + :UPDATED: [2023-10-24 Tue 23:31] :END: This is a PoC experiment, demonstrating the power of emacs-web-server. @@ -15,17 +15,27 @@ The goal is not to implement something fancy, but: The first item is quite achievable. Regarding the second, it would be ideal to have a package that transforms emacs packages to webapps. - -So far in this experiment we have implemented a webapp only. +This package showcases a prototype of such a transformer, which needs +to separated. * Usage :PROPERTIES: :UPDATED: [2023-10-08 Sun 15:35] :END: -** Serve from current emacs instance +** As an emacs package + :PROPERTIES: + :UPDATED: [2023-10-24 Tue 23:35] + :END: +There are two entry points: + +- ~M-x bom~: opens a "landing page" as an org buffer +- ~M-x bom-state~: prompt for a state, then displays the weather + forecast for that state in an org buffer + +** Serve web pages from current emacs instance :PROPERTIES: - :UPDATED: [2023-10-08 Sun 15:39] + :UPDATED: [2023-10-24 Tue 23:37] :END: Make sure =emacs-web-server= is available. It can be installed from the GNU ELPA: @@ -43,9 +53,9 @@ Require and start the server: The weather forecast is available at . -** Serve as purely a webapp +** Serve web pages from the command line :PROPERTIES: - :UPDATED: [2023-10-08 Sun 15:40] + :UPDATED: [2023-10-24 Tue 23:37] :END: Run ~make serve~. -- cgit v1.2.3