Skip to content

Commit

Permalink
docs: Update README.
Browse files Browse the repository at this point in the history
  • Loading branch information
srackham committed May 15, 2020
1 parent a3de90c commit a307c40
Showing 1 changed file with 4 additions and 20 deletions.
24 changes: 4 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,7 @@ for [Deno](https://deno.land/) inspired by
- File tasks and non-file tasks.
- Drake API functions for defining, registering and running tasks.

**NOTE**: This is a development release and will be subject to
breaking changes until 1.0 (search the Git commit log for `BREAKING
CHANGE`). A 1.0 production release will follow once Deno has reached
1.0. If you get TypeScript compilation errors try reloading the Deno
cache, for example: `deno cache -r Drakefile.ts`

Tested with Deno 1.0.0-rc3 running on Ubuntu 18.04.
Tested with Deno 1.0.0 running on Ubuntu 18.04.


## Drakefiles
Expand All @@ -30,7 +24,7 @@ A drakefile is a TypeScript module that:
Example drakefile:

``` typescript
import { desc, run, task } from "https://deno.land/x/drake@v1.0.0-rc3/mod.ts";
import { desc, run, task } from "https://deno.land/x/drake@v1.0.0/mod.ts";

desc("Minimal Drake task");
task("hello", [], function() {
Expand Down Expand Up @@ -469,27 +463,17 @@ Returns the Drake version number string.
* `` \` `` translates to `` ` ``
* `\${` translates to `${`

- You can use Drake API functions in non-drakefiles. Useful utility
functions include: `abort`, `debug`, `glob`, `log`, `quote`,
`readFile`, `sh`, `shCapture`, `updateFile`, `writeFile`.

- Drake API debug messages will be emitted if the `DRAKE_DEBUG` shell
environment variable is set. This can be useful when executing
non-Drakefiles (in lieu of the Drake `--debug` command-line option).
You can also "debug" sections of code with `env("--debug",true)` and
`env("--debug",false)`.

- By default Drake functions manifest errors by printing an error
message and exiting with a non-zero exit code. You can change the
default behavior so that errors throw a `DrakeError` exception by
setting `env("--abort-exits", false)`.

- Specify the Drake version to import in the `import` statement URL.
The first example imports the HEAD of the `master` branch; the
second imports the commit tagged `v1.0.0-rc3`:
second imports the commit tagged `v1.0.0`:

import { desc, run, task } from "https://deno.land/x/drake/mod.ts";
import { desc, run, task } from "https://deno.land/x/drake@v1.0.0-rc3/mod.ts";
import { desc, run, task } from "https://deno.land/x/drake@v1.0.0/mod.ts";

- The Deno `run` command automatically compiles updated source and
writes compilation messages to `stderr`. This can interfere with tests
Expand Down

0 comments on commit a307c40

Please sign in to comment.