From 4fa5d8b99cb217796962f8b9a1b34110ef5831fa Mon Sep 17 00:00:00 2001 From: TeoDev1611 Date: Sun, 9 Oct 2022 20:59:15 -0500 Subject: [PATCH] feat: add the readme --- README.md | 52 +++++++++++++++++++++++++++++++++++++++++++++++++++- examples.ts | 23 +++++++++++++++-------- 2 files changed, 66 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 7fbcd8d..89cc272 100644 --- a/README.md +++ b/README.md @@ -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 --- diff --git a/examples.ts b/examples.ts index a87ed11..f3fc381 100644 --- a/examples.ts +++ b/examples.ts @@ -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! + }, });