aboutsummaryrefslogtreecommitdiff
path: root/pandoc-server/README.md
diff options
context:
space:
mode:
authorJohn MacFarlane <[email protected]>2022-09-22 09:47:07 -0700
committerGitHub <[email protected]>2022-09-22 09:47:07 -0700
commitbd1d923b86edba6e090ba14b1cd17e1e32c727f2 (patch)
treed9aa17acc41811a9664815766c72e0f5bf7d239b /pandoc-server/README.md
parentb38292c2346ebea690eada91a5ac1e0addaa3c0b (diff)
Split pandoc-server, pandoc-cli into separate packages. (#8309)
This also removes the unnecessary Setup.hs from pandoc. Cabal does not need this with build-type 'simple'.
Diffstat (limited to 'pandoc-server/README.md')
-rw-r--r--pandoc-server/README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/pandoc-server/README.md b/pandoc-server/README.md
new file mode 100644
index 000000000..346b3461a
--- /dev/null
+++ b/pandoc-server/README.md
@@ -0,0 +1,26 @@
+# pandoc-server
+
+`pandoc-server` is a Haskell library providing access to
+pandoc's document conversions as an HTTP server.
+
+For a description of the API, see
+[pandoc-server.md](https://github.com/jgm/pandoc/blob/master/doc/pandoc-server.md)
+in the pandoc source repository.
+
+Example of use:
+
+``` hs
+module Main where
+import Text.Pandoc.Server (app)
+import qualified Network.Wai.Handler.Warp as Warp
+
+main :: IO ()
+main = Warp.run 3000 app
+```
+
+## License
+
+© 2006-2022 John MacFarlane ([email protected]). Released under the
+[GPL](https://www.gnu.org/licenses/old-licenses/gpl-2.0.html "GNU General Public License"),
+version 2 or greater. This software carries no warranty of any kind.
+(See COPYRIGHT for full copyright and warranty notices.)