diff options
| -rw-r--r-- | README.org | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/README.org b/README.org new file mode 100644 index 0000000..376d697 --- /dev/null +++ b/README.org @@ -0,0 +1,60 @@ +#+title: bom.el +#+author: Yuchen Pei <id@ypei.org> + +* Introduction + :PROPERTIES: + :UPDATED: [2023-10-08 Sun 15:47] + :END: + +This is a PoC experiment, demonstrating the power of emacs-web-server. + +The goal is not to implement something fancy, but: + +1. Banish Javascript +2. Write an emacs package, get a webapp for free + +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. + +* Usage + :PROPERTIES: + :UPDATED: [2023-10-08 Sun 15:35] + :END: + +** Serve from current emacs instance + :PROPERTIES: + :UPDATED: [2023-10-08 Sun 15:39] + :END: +Make sure =emacs-web-server= is available. It can be installed from +the GNU ELPA: + +#+begin_src emacs-lisp +(package-install 'web-server) +#+end_src + +Require and start the server: + +#+begin_src emacs-lisp +(require 'bom) +(bom-start) +#+end_src + +The weather forecast is available at <http://localhost:9000>. + +** Serve as purely a webapp + :PROPERTIES: + :UPDATED: [2023-10-08 Sun 15:40] + :END: + +Run ~make serve~. + +* Contact and Copyright + :PROPERTIES: + :UPDATED: [2023-10-08 Sun 15:42] + :END: + +=bom.el= is maintained by Yuchen Pei <id@ypei.org> and covered by [[https://www.gnu.org/licenses/agpl-3.0.en.html][GNU +AGPLv3+]]. You may find the license text in a file named COPYING.agpl3 +in the project tree. |