Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
Signed-off-by: seven <[email protected]>
  • Loading branch information
Blankll committed Sep 18, 2024
1 parent 4e3dd86 commit 6e1d576
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 2 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/node.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
name: Node.js CI

on:
push:
branches: [master]
pull_request:
branches: [master]

Expand Down
35 changes: 33 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,48 @@
# ServerlessInsight
[![Node.js CI](https://github.com/geek-fun/hostsless/actions/workflows/node.yml/badge.svg)](https://github.com/geek-fun/hostsless/actions/workflows/node.yml)

Full life cycle cross providers serverless application management for your fast-growing business.
[![Node.js CI](https://github.com/geek-fun/serverlessinsight/actions/workflows/node.yml/badge.svg)](https://github.com/geek-fun/serverlessinsight/actions/workflows/node.yml)
[![release](https://github.com/geek-fun/serverlessinsight/actions/workflows/release.yml/badge.svg)](https://github.com/geek-fun/serverlessinsight/actions/workflows/release.yml)
[![npm version](https://badge.fury.io/js/@geek-fun%2Fserverlessinsight.svg)](https://badge.fury.io/js/@geek-fun%2Fserverlessinsight)
[![Known Vulnerabilities](https://snyk.io/test/github/geek-fun/serverlessinsight/badge.svg)](https://snyk.io/test/github/geek-fun/serverlessinsight)
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

Full life cycle cross providers serverless application management for your fast-growing business.

## Quick Start
### prerequisites
- Node.js 16.x
### Install
```bash
npm install -g @geek-fun/serverlessinsight
```
### Usage
```bash
si -h
```
#### Initialize a new project
```bash
si init
```
#### Deploy the application
```bash
si deploy
```
#### Remove the application
```bash
si remove
```

## Development

Link ServerlessInsight globally to use the CLI tool.

```bash
npm run build
npm link
```

run the command then:

```bash
si -h
```

0 comments on commit 6e1d576

Please sign in to comment.