Skip to content

Commit

Permalink
docs(README): add documentation for components
Browse files Browse the repository at this point in the history
  • Loading branch information
vulcangz committed Mar 15, 2021
1 parent 68529c8 commit 5d22ee1
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 6 deletions.
6 changes: 4 additions & 2 deletions README-zh_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,12 @@ Svelte 百度地图组件基于[百度地图 JavaScript API v2.0 类参考](http

## 演示

[在线演示](https://vulcangz.github.io/svelte-baidumaps/demo/)
* 交互式演示: [https://svelte.worldlink.com.cn/examples](https://svelte.worldlink.com.cn/examples)
* 简单演示: [https://vulcangz.github.io/svelte-baidumaps/demo/](https://vulcangz.github.io/svelte-baidumaps/demo/)

## 用法

* 文档: [https://svelte.worldlink.com.cn/docs](https://svelte.worldlink.com.cn/docs)
* 简单参考: [App.svelte](https://github.com/vulcangz/svelte-baidumaps/tree/master/src/App.svelte)
* 交互式演示: [Demo with REPL support](https://svelte.worldlink.com.cn/examples)

Expand Down Expand Up @@ -117,7 +119,7 @@ npm run dev
## Todo

* test
* docs
* ~~docs~~

## 致谢及参考

Expand Down
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@

English | [简体中文](./README-zh_CN.md)

Svelte components based on Baidu Map JavaScript Api package.
Svelte components based on Baidu Map JavaScript API package.

## Demo

* [https://vulcangz.github.io/svelte-baidumaps/demo/](https://vulcangz.github.io/svelte-baidumaps/demo/)
* [Demo with REPL support](https://svelte.worldlink.com.cn/examples)
* Demo with REPL support: [https://svelte.worldlink.com.cn/examples](https://svelte.worldlink.com.cn/examples)
* Simple Demo: [https://vulcangz.github.io/svelte-baidumaps/demo/](https://vulcangz.github.io/svelte-baidumaps/demo/)

## Install

Expand All @@ -16,6 +16,7 @@ npm install --save @vulcangz/svelte-baidumaps
```
## Usage

* Documentation: [https://svelte.worldlink.com.cn/docs](https://svelte.worldlink.com.cn/docs)
* Simple reference: [App.svelte](https://github.com/vulcangz/svelte-baidumaps/tree/master/src/App.svelte)
* Usage examples: [Demo with REPL support](https://svelte.worldlink.com.cn/examples)

Expand Down Expand Up @@ -115,7 +116,7 @@ See [PointCollection](http://lbsyun.baidu.com/cms/jsapi/reference/jsapi_referenc
## Todo

* test
* docs
* ~~docs~~

## Credits and Inspiration

Expand Down

0 comments on commit 5d22ee1

Please sign in to comment.