diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..beb60ba --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,18 @@ +# [1.0.0](https://github.com/daiwanxing/bmap-loader/compare/0.1.0...1.0.0) (2023-02-20) + +### chore + +- 输出 bundle ([f1ce969](https://github.com/daiwanxing/bmap-loader/commit/f1ce969a531b824974da0c92a6f424a241e7f43b)) + +### docs + +- 新增 demo 示例 ([7ddd180](https://github.com/daiwanxing/bmap-loader/commit/7ddd1803fbce41ef085fac0160c98c72c88bb313)) + +### refactor + +- package 重命名,优化资源输出 ([acabd7a](https://github.com/daiwanxing/bmap-loader/commit/acabd7a1cd2c82ccd0874262462a3c0cda035df6)) + +### test + +- 新增 commit 前缀 ([c12ad9a](https://github.com/daiwanxing/bmap-loader/commit/c12ad9ad8b29439c886dc196a96275567bd13106)) +- 重新编写测试用例 ([2de76b3](https://github.com/daiwanxing/bmap-loader/commit/2de76b38b591c4a8f0abca3d22eca4cb6f129b20)) diff --git a/README.md b/README.md index a1da700..d8d0bc1 100644 --- a/README.md +++ b/README.md @@ -4,36 +4,37 @@ ![downloads](https://img.shields.io/npm/dt/bmap-loader.svg) ![version](https://img.shields.io/npm/v/bmap-loader) -`bmap-loader` 是一个小巧的易于加载百度地图以及地图开源工具库的插件, `bmap-loader` 的灵感来源于 [amap-jsapi-loader](https://www.npmjs.com/package/@amap/amap-jsapi-loader)。 +`bmap-jsapi-loader` 是一个小巧的易于加载百度地图以及地图开源工具库的插件, `bmap-jsapi-loader` 的灵感来源于 [@googlemaps/js-api-loader](https://www.npmjs.com/package/@googlemaps/js-api-loader)。 ### 特点 -- 🎨支持以 UMD 和 ESM 两种模块方式使用 -- 🪄为 TypeScript 用户提供完善的类型支持 -- ⚡异步加载百度地图脚本 -- 💌可加载 bmap 3.0 或者 bmap-gl 两个版本 -- 💡支持加载百度地图开源库 -- 📦提供完善的单元测试 +- 🎨 支持以 UMD 和 ESM 两种模块方式使用 +- 🪄 为 TypeScript 用户提供完善的类型支持 +- ⚡ 异步加载百度地图脚本 +- 💌 可加载 bmap 3.0 或者 bmap-gl 两个版本 +- 💡 支持加载百度地图开源库 +- 📦 提供完善的单元测试 # 安装 ## 以包管理工具的方式安装 ### 使用 NPM: + ```shell -$ npm install bmap-loader --save +$ npm install @wonderdai/bmap-jsapi-loader --save ``` ### 使用 Yarn: ```shell -$ yarn add bmap-loader --save +$ yarn add @wonderdai/bmap-jsapi-loader --save ``` ### 使用 PNPM: ```shell -$ pnpm install bmap-loader --save +$ pnpm install @wonderdai/bmap-jsapi-loader --save ``` ## 以 CDN 的方式使用 @@ -47,10 +48,10 @@ $ pnpm install bmap-loader --save ### 示例 ```js -import BMapLoader from "bmap-loader"; +import { loader } from "@wonderdai/bmap-jsapi-loader"; // 安装 Javascrtip-API 3.0 版本的百度地图 -BMapLoader({ +loader({ v: "3.0", ak: "填写你的ak密钥", }).then(() => { @@ -68,7 +69,7 @@ BMapLoader({ }) // 安装 Javascrtip-API GL 版本的百度地图 -BMapLoader({ +loader({ v: "1.0", type: "webgl" ak: "填写你的ak密钥",