Skip to content

Commit

Permalink
docs: restore readme as main module doc
Browse files Browse the repository at this point in the history
  • Loading branch information
hugojosefson committed Oct 27, 2024
1 parent 73fc564 commit 75e4d58
Show file tree
Hide file tree
Showing 3 changed files with 2 additions and 16 deletions.
6 changes: 1 addition & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,8 @@ deno add jsr:@hugojosefson/run-simple

```typescript
// example-usage.ts
import { run } from "@hugojosefson/run-simple";

/**
* This example shows some ways to use the run function.
* @module
*/
import { run } from "@hugojosefson/run-simple";

// Simple command
const dir: string = await run("ls -l");
Expand Down
6 changes: 0 additions & 6 deletions mod.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
/**
* This module exports the {@link run} function and its varieties, and the types
* that they use.
* @module
*/

export { run } from "./src/run.ts";
export type { RunOptions } from "./src/run.ts";
export type { CommandFailure } from "./src/run.ts";
Expand Down
6 changes: 1 addition & 5 deletions readme/example-usage.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,7 @@
#!/usr/bin/env -S deno run --allow-run=ls,id,ssh
// example-usage.ts
import { run } from "../mod.ts";

/**
* This example shows some ways to use the run function.
* @module
*/
import { run } from "../mod.ts";

// Simple command
const dir: string = await run("ls -l");
Expand Down

0 comments on commit 75e4d58

Please sign in to comment.