update docs and description
This commit is contained in:
parent
d7443bbf17
commit
e8fe4f1720
38
docs/getstarted.md
Normal file
38
docs/getstarted.md
Normal file
@ -0,0 +1,38 @@
|
||||
---
|
||||
name: Get Started
|
||||
description: learn how to quickly write npm TypeScript modules
|
||||
---
|
||||
# Get Started with NPMTS
|
||||
and learn how to quickly write npm TypeScript modules
|
||||
|
||||
## Step1: Install the tools
|
||||
|
||||
To use npmts install it using npm or yarn:
|
||||
|
||||
```shell
|
||||
npm install -g npmts # install with npm
|
||||
yarn global add npmts # install with yarn
|
||||
```
|
||||
|
||||
For the puspose of getting started quickly also install **gitzone**.
|
||||
It'll proovide awesome scaffolding for new npmts npm modules and also updates them later on.
|
||||
|
||||
```shell
|
||||
npm install -g gitzone # install with npm
|
||||
yarn global add gitzone # install with yarn
|
||||
```
|
||||
|
||||
You can make sure npmts and gitzone are installed correctly by typing `npmts -v && gitzone -v`.
|
||||
|
||||
## Scaffold a new module
|
||||
|
||||
To scaffold a new module type
|
||||
|
||||
```shell
|
||||
gitzone template npm
|
||||
```
|
||||
|
||||
This will run you through a series of question to get gitzone to know the specifics of your module.
|
||||
Enter all information accordingly.
|
||||
|
||||
## Run NPMTS for the first time
|
@ -1,8 +1,9 @@
|
||||
---
|
||||
name: Start
|
||||
name: Index
|
||||
description: best practice npm TypeScript modules
|
||||
---
|
||||
# npmts
|
||||
Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.
|
||||
best practice npm TypeScript modules
|
||||
|
||||
## Availabililty
|
||||
[![npm](https://gitzone.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/npmts)
|
||||
|
@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "npmts",
|
||||
"version": "8.0.1",
|
||||
"description": "Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.",
|
||||
"description": "best practice npm TypeScript modules",
|
||||
"main": "dist/index.js",
|
||||
"bin": {
|
||||
"npmts": "assets/cliNpmts.js"
|
||||
|
Loading…
Reference in New Issue
Block a user