From 0ff9ac2fb942e82d6e4dcbbeb29df5ea58da23ba Mon Sep 17 00:00:00 2001 From: Calvin Rose Date: Fri, 16 Nov 2018 22:36:47 -0500 Subject: [PATCH] Update README.md --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 72f503bd..744c3552 100644 --- a/README.md +++ b/README.md @@ -50,6 +50,16 @@ API documentation and design documents can be found in the [wiki](https://github.com/bakpakin/janet/wiki). There is an introduction section in the wiki that contains a good overview of the language. +For individual bindings, use the `(doc symbol-name)` macro to get API +documentation for the core library. For example, +``` +(doc doc) +``` +Shows documentation for the doc macro. + +To get a list of all bindings in the default +environment, use the `(all-symbols)` function. + ## Usage A repl is launched when the binary is invoked with no arguments. Pass the -h flag