yeet

.config/emacs/modules/lang/rest/README.org

@@ -0,0 +1,58 @@
+#+TITLE:   lang/rest
+#+DATE:    March 17, 2017
+#+SINCE:   v1.3
+#+STARTUP: inlineimages nofold
+
+* Table of Contents :TOC_3:noexport:
+- [[#description][Description]]
+  - [[#maintainers][Maintainers]]
+  - [[#module-flags][Module Flags]]
+  - [[#plugins][Plugins]]
+  - [[#hacks][Hacks]]
+- [[#prerequisites][Prerequisites]]
+- [[#features][Features]]
+- [[#configuration][Configuration]]
+- [[#troubleshooting][Troubleshooting]]
+
+* Description
+This module adds [[https://en.wikipedia.org/wiki/Representational_state_transfer][REST]] support.
+
++ Code-completion (~company-restclient~)
++ Code evaluation
++ Imenu support for ~restclient-mode~
++ org-mode: babel support (~ob-restclient~)
+
+#+begin_quote
+~restclient-mode~ is tremendously useful for automated or quick testing REST
+APIs. My workflow is to open an ~org-mode~ buffer, create a restclient source
+block and hack away. ~restclient-mode~ and ~company-restclient~ power this
+arcane wizardry.
+#+end_quote
+
+** Maintainers
+This module has no dedicated maintainers.
+
+** Module Flags
+This module provides no flags.
+
+** Plugins
++ [[https://github.com/pashky/restclient.el][restclient]]
++ =:completion company=
+  + [[https://github.com/iquiw/company-restclient][company-restclient]]
+
+** Hacks
++ restclient has been modified not to silently reject self-signed or invalid
+  certificates.
++ Adds imenu support to ~restclient-mode~.
+
+* Prerequisites
+This module has no prerequisites.
+
+* Features
+# An in-depth list of features, how to use them, and their dependencies.
+
+* Configuration
+# How to configure this module, including common problems and how to address them.
+
+* Troubleshooting
+# Common issues and their solution, or places to look for help.