Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
hustcc committed Oct 9, 2023
1 parent a759533 commit e19454d
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 21 deletions.
29 changes: 19 additions & 10 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions

name: Build
name: build

on:
push:
Expand All @@ -24,12 +24,21 @@ jobs:
# See supported Node.js release schedule at https://nodejs.org/en/about/releases/

steps:
- uses: actions/checkout@v2
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v2
with:
node-version: ${{ matrix.node-version }}
- run: npm install -g yarn
- run: yarn
- run: yarn build
- run: yarn test
- name: Checkout
uses: actions/[email protected]

- name: Setup Node.js environment
uses: actions/[email protected]
with:
node-version: ${{ matrix.node-version }}

- name: Run ci
run: |
npm install
npm run test
npm run build
- name: coverall
if: success()
uses: coverallsapp/github-action@master
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
18 changes: 14 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,20 @@
# Graphlib
<h1 align="center">
<b>@antv/graphlib</b>
</h1>

> a lib containing multible usages for graph structure, graph algorithm, and other graph ops.
<div align="center">

> A library containing multible usages for graph structure, graph algorithm, and other graph ops.
>
> 一个包含方便的图结构,图算法,以及其他操作图的方法的图库,为 antv 上层提供相应的图基础能力
> 一个包含方便的图结构,图算法,以及其他操作图的方法的图库,为 AntV 上层提供相应的图基础能力。
[![Build Status](https://github.com/antvis/graphlib/workflows/build/badge.svg?branch=master)](https://github.com/antvis/graphlib/actions)
[![Coverage Status](https://img.shields.io/coveralls/github/antvis/graphlib/master.svg)](https://coveralls.io/github/antvis/graphlib?branch=master)
[![npm Version](https://img.shields.io/npm/v/@antv/graphlib.svg)](https://www.npmjs.com/package/@antv/graphlib)
[![npm Download](https://img.shields.io/npm/dm/@antv/graphlib.svg)](https://www.npmjs.com/package/@antv/graphlib)
[![npm License](https://img.shields.io/npm/l/@antv/graphlib.svg)](https://www.npmjs.com/package/@antv/graphlib)

![build status](https://img.shields.io/github/workflow/status/antvis/graphlib/Build) ![coverage status](https://img.shields.io/codecov/c/github/antvis/graphlib)
</div>

## Features

Expand Down
14 changes: 7 additions & 7 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
{
"name": "@antv/graphlib",
"version": "2.0.2",
"main": "lib/index.js",
"module": "esm/index.js",
"types": "lib/index.d.ts",
"unpkg": "dist/index.umd.min.js",
"sideEffects": false,
"scripts": {
"clean": "rimraf lib esm dist",
Expand All @@ -16,11 +20,6 @@
"build": "run-p build:*",
"bundle-vis": "cross-env BUNDLE_VIS=1 run-p build:umd"
},
"license": "MIT",
"main": "lib/index.js",
"module": "esm/index.js",
"types": "lib/index.d.ts",
"unpkg": "dist/index.umd.min.js",
"dependencies": {
"@antv/event-emitter": "^0.1.3"
},
Expand Down Expand Up @@ -62,7 +61,7 @@
"limit-size": [
{
"path": "dist/index.umd.min.js",
"limit": "10 Kb",
"limit": "5 Kb",
"gzip": true
}
],
Expand All @@ -77,5 +76,6 @@
"publishConfig": {
"access": "public",
"registry": "https://registry.npmjs.org"
}
},
"license": "MIT"
}

0 comments on commit e19454d

Please sign in to comment.