@mappable-world/mappable-hint - npm Package Compare versions

Comparing version 0.0.2-beta.8 to 0.0.2-beta.9

CONTRIBUTING.md

package.json

		{
		"version": "0.0.2-beta.8",
		"version": "0.0.2-beta.9",
		"name": "@mappable-world/mappable-hint",
		@@ -4,0 +4,0 @@ "description": "Hints for Mappable Maps JS API 3.0",

README.md

		# Mappable JS API Hints Package

		---

		[![Build Status](https://github.com/mappable-world/mappable-hint/workflows/Run%20tests/badge.svg)](https://github.com/mappable-world/mappable-hint/actions/workflows/tests.yml)
		[![npm version](https://badge.fury.io/js/@mappable-world%2Fmappable-hint.svg)](https://badge.fury.io/js/@mappable-world%2Fmappable-hint)
		[![npm](https://img.shields.io/npm/dm/@mappable-world/mappable-hint.svg)](https://www.npmjs.com/package/@mappable-world/mappable-hint)

		The package adds the functionality of hanging hints on map elements

		## How use

		The package is located in the `dist` folder:
		@@ -35,51 +45,1 @@
		```

		## Contributing

		> To get started in the `.env` file, you need to declare `APIKEY` https://mappable.world/docs/js-api/quickstart.html#get-api-key:

		To get started:

		```sh
		npm start
		```

		or so if you didn't create the `.env` file

		```sh
		APIKEY=%APIKEY% npm start
		```

		To check with linter:

		```sh
		npm run lint
		```

		For the final build:

		```sh
		npm run build
		```

		## GitHub actions

		After you create a new tag, or just push changes to the server, ci will be launched

		```sh
		npm version prerelease --preid=beta --no-git-tag-version
		git add --all
		git commit -m "New version"
		git tag 0.0.1-beta.2
		git push --tags origin HEAD:main
		```

		CI described here

		- `.github/workflows/release.yml` - triggered when a new tag is created
		- `.github/workflows/tests.yml` - triggers on any push to the main branch

		For it to work, you need to declare two secrets in the GitHub Action:

		- `APIKEY` - To run autotests on the JS API https://mappable.world/docs/js-api/quickstart.html#get-api-key
		- `NPM_TOKEN` - To publish your package to npm

@mappable-world/mappable-hint - npm Package Compare versions

New alerts

Fixed alerts

Improved metrics

Worsened metrics