Skip to content

Commit

Permalink
feat!: Release new org scoped package (#155)
Browse files Browse the repository at this point in the history
There is no breaking change. [Conventional commits specification](https://www.conventionalcommits.org/en/v1.0.0/) only releases a major version if there is breaking change text in the footer.

BREAKING CHANGE: Release new org scoped package
  • Loading branch information
kunalnagar authored Jul 23, 2024
1 parent a1a9bc8 commit 98a7bd8
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 26 deletions.
28 changes: 5 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,13 @@
# IMPORTANT NOTICE
# @kunalnagarco/jquery-peek-a-bar

Hello all,

Thanks for using this jQuery plugin to show notification bars in your web apps. Your love and support for this plugin is what motivates me to maintain it in an ever-changing world of newer front-end frameworks.

## What's changing

- [x] (Mar 16, 2024) Update README with a deprecation warning to give users enough time to prepare for the move
- [x] (June 16, 2024) Move plugin to the @kunalnagarco organization
- [ ] (July 16, 2024) Deprecate the [npm jquery-peek-a-bar package](https://www.npmjs.com/package/jquery-peek-a-bar) and create a new package under the org scope i.e. `@kunalnagarco/jquery.peekABar`

## What's not changing

- No breaking changes
- No API changes
- This is purely a major bump for moving to the organization

# jquery.peekABar

[![npm version](https://img.shields.io/npm/v/jquery-peek-a-bar.svg)](https://www.npmjs.com/package/jquery-peek-a-bar)
<!-- [![npm version](https://img.shields.io/npm/v/jquery-peek-a-bar.svg)](https://www.npmjs.com/package/jquery-peek-a-bar) -->

A jQuery plugin for a notification bar with customization options.

## Installation

```
npm install jquery-peek-a-bar --save
```bash
npm install @kunalnagarco/jquery-peek-a-bar --save
```

## Options
Expand Down Expand Up @@ -172,7 +154,7 @@ bar.show({

## Support

For any issues/queries, please open a new [Github Issue](https://github.com/kunalnagar/jquery.peekABar/issues).
For any issues/queries, please open a new [Github Issue](https://github.com/kunalnagarco/jquery.peekABar/issues).

## Share

Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "jquery-peek-a-bar",
"name": "@kunalnagarco/jquery-peek-a-bar",
"version": "3.7.0",
"description": "A jQuery plugin for a notification bar with a lot of customization options.",
"main": "dist/js/jquery.peekabar.js",
Expand Down Expand Up @@ -42,7 +42,7 @@
],
"repository": {
"type": "git",
"url": "git://github.com/kunalnagar/jquery.peekABar.git"
"url": "git://github.com/kunalnagarco/jquery.peekABar.git"
},
"publishConfig": {
"access": "public"
Expand Down
2 changes: 1 addition & 1 deletion src/js/peekabar.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* @license
* jquery.peekABar <https://kunalnagarco.github.io/jquery.peekABar>
* @kunalnagarco/jquery-peek-a-bar <https://kunalnagarco.github.io/jquery.peekABar>
* Copyright 2019 Kunal Nagar
* Available under MIT license
*/
Expand Down

0 comments on commit 98a7bd8

Please sign in to comment.