Browse Source

Update readme

HonorLee 1 year ago
parent
commit
7f8129e56b
1 changed files with 46 additions and 0 deletions
  1. 46 0
      README.md

+ 46 - 0
README.md

@@ -0,0 +1,46 @@
+# SugarNode-TS
+This is a fast-easy development framework for NodeJs with Typescript.
+
+## Purpose
+
+## Overview
+
+### 1. Install node modules
+```
+npm i
+```
+### 2. Install Typescript-Cli if necessary
+```
+npm i -g typescript
+```
+### 3. Try build
+```
+npm build
+```
+or
+```
+tsc
+```
+
+### 4.Try run a server for test
+```
+npm start
+```
+There are some examples in ```dist/app``` folder, you can edit by yourself for test.
+## Features
+```
+Waiting...
+```
+
+## Tutorials
+```
+Waiting...
+```
+## TODO
+```
+Waiting...
+```
+## License
+This project is licensed under the MIT license. Copyrights are respective of each contributor listed at the beginning of each definition file.
+
+