From 87d5e55a61c1f2abc819f885d83dd9e38942f176 Mon Sep 17 00:00:00 2001 From: Omar Mahili Date: Mon, 7 Mar 2022 16:45:59 +0100 Subject: [PATCH] Release 0.1.0 (#42) - Improve readme for release - Add changelog - Bump package version to 0.1.0 --- CHANGELOG.md | 18 +++++++++++++++++ README.md | 49 ++++++++++++++++++++++++++++++++++++----------- package-lock.json | 1 + package.json | 1 + 4 files changed, 58 insertions(+), 11 deletions(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..0d431fb --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,18 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +## [0.1.0] - 2022-03-08 +### Added +- Configurable seat map with cart and legend +- Basic functions to manage seats and cart +- Event listeners +- Minified js and css +- TypeScript declaration file + +[Unreleased]: https://github.com/omahili/seatchart.js/compare/v0.1.0...HEAD +[0.1.0]: https://github.com/omahili/seatchart.js/releases/tag/v0.1.0 diff --git a/README.md b/README.md index 5698777..9d591e8 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,23 @@ Create beautiful designed seat maps 💺🗺️ - [Demo](https://seatchart.js.org/demo.html) - [Docs](https://seatchart.js.org) +## Install + +You can get seatchart from npm or use a CDN like [jsDelivr](https://www.jsdelivr.com). + +### Npm + +``` +npm install --save seatchart +``` + +### JsDelivr + +``` +https://cdn.jsdelivr.net/npm/seatchart@0.1.0/dist/seatchart.min.js +https://cdn.jsdelivr.net/npm/seatchart@0.1.0/dist/seatchart.min.css +``` + ## Usage ```html @@ -13,7 +30,7 @@ Create beautiful designed seat maps 💺🗺️ Seatchart Example - +