History

Luke Hoban 1d7792cd83 Allow additional configuration on aws.serverless.Function We need to provide higher level abstractions with the ability to set additional properties on a Lambda Function even when using the closure serialization support of aws.serverless.Function. Note that this is an API breaking change, and may require updates in any other libraries dependent on this API.		2017-07-09 21:03:31 -07:00
..
aws	Allow additional configuration on aws.serverless.Function	2017-07-09 21:03:31 -07:00
lumi	Clarify aspects of using the DCO	2017-06-26 14:46:34 -07:00
lumijs	Support try/catch in Lumi and async/await in Node.js	2017-07-07 12:47:27 -07:00
lumirt	Clarify aspects of using the DCO	2017-06-26 14:46:34 -07:00
mantle	Clarify aspects of using the DCO	2017-06-26 14:46:34 -07:00
README.md	Preserve the lumi prefix on our CLI tools	2017-05-18 12:38:58 -07:00

README.md

lumi/lib

This directory contains some libraries that Lumi programs may depend upon.

Overview

The Lumi standard library underneath lumi/ is special in that every program will ultimately use it directly or indirectly to create resources.

Similarly, lumijs/ is the LumiJS compiler's runtime library, and so most LumiJS programs will on it.

Note that these are written in the Lumi subsets of the languages and therefore cannot perform I/O, etc.

Installation and Usage

Eventually these packages will be published like any other NPM package. For now, they are consumed only in a development capacity, and so there are some manual steps required to prepare a developer workspace.

For each library <lib> you wish to use, please see its install.sh script in its root directory. This performs installation so that it can be used simply by adding a dependency to it.

We currently use NPM/Yarn symlinks to ease the developer workspace flow. As such, you will need to run:

yarn link <lib>

In a project that intends to consume <lib> before actually using it. For example, yarn link @lumi/lumi.