Skip to content

Commit

Permalink
feat: add the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
TeoDev1611 committed Oct 10, 2022
1 parent 0fc85c5 commit 4fa5d8b
Show file tree
Hide file tree
Showing 2 changed files with 66 additions and 9 deletions.
52 changes: 51 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,60 @@

Do you want generate a installer for your app use this!!

## Usage and Installation

### Installation

`dpm install monk` or with **dpm +0.2.0** you can use `dpm bundle installer`

Or import like:

```ts
import { Monk } from 'https://deno.land/x/monk/mod.ts';
```

### Usage

```ts
import { Monk } from 'https://deno.land/x/monk/mod.ts';

await Monk({
versions: {
downloadVersion: 'stable', // Here you can add the version for download only canary or stable!
stable: {
url: 'https://github.com/dpmland/dpm', // Here you add the url and branch for the stable and canary
branch: 'main',
},
canary: {
url: 'https://github.com/dpmland/dpm',
branch: 'dev',
},
},
files: {
appName: 'dpm', // With this name compile the app into a binary!
stable: {
importMapFile: './import_map.json', // This route is necessary for the compilation!
mainFile: './dpm.ts',
},
canary: {
importMapFile: './import_map.json',
mainFile: './dpm.ts',
},
},

// OPTIONAL
social: {
github: 'https://github.com/dpmland/dpm', // The GitHub Repo for more information!
discord: 'https://discord.com/invite/Um27YPJKud', // The Discord Server for more information!
errors: 'https://github.com/dpmland/dpm/issues', // The issues route for the bugs!
},
});
```

## Information :book:

- **Author:** DPM LAND Authors
- **Version:** 0.1.0-alpha
- **Version:** 0.1.0
- **License:** MIT

---
Expand Down
23 changes: 15 additions & 8 deletions examples.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,32 @@ import { Monk } from './mod.ts';

await Monk({
versions: {
downloadVersion: 'stable',
downloadVersion: 'stable', // Here you can add the version for download only canary or stable!
stable: {
url: 'https://github.com/TeoDev1611/spider',
url: 'https://github.com/dpmland/dpm', // Here you add the url and branch for the stable and canary
branch: 'main',
},
canary: {
url: 'https://github.com/TeoDev1611/octorg',
branch: 'main',
url: 'https://github.com/dpmland/dpm',
branch: 'dev',
},
},
files: {
appName: 'spider',
appName: 'dpm', // With this name compile the app into a binary!
stable: {
importMapFile: './import_map.json',
mainFile: './src/cli.ts',
importMapFile: './import_map.json', // This route is necessary for the compilation!
mainFile: './dpm.ts',
},
canary: {
importMapFile: './import_map.json',
mainFile: './cli.ts',
mainFile: './dpm.ts',
},
},

// OPTIONAL
social: {
github: 'https://github.com/dpmland/dpm', // The GitHub Repo for more information!
discord: 'https://discord.com/invite/Um27YPJKud', // The Discord Server for more information!
errors: 'https://github.com/dpmland/dpm/issues', // The issues route for the bugs!
},
});

0 comments on commit 4fa5d8b

Please sign in to comment.