Skip to content

Commit

Permalink
BREAKING CHANGE: Change library npm organization to almacareer (fixes #…
Browse files Browse the repository at this point in the history
  • Loading branch information
OndraM committed Jan 7, 2025
1 parent 8056d04 commit c54d991
Show file tree
Hide file tree
Showing 7 changed files with 21 additions and 20 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[![npm version](https://img.shields.io/npm/v/@lmc-eu/cookie-consent-manager.svg)](https://www.npmjs.com/package/@lmc-eu/cookie-consent-manager)
[![npm version](https://img.shields.io/npm/v/@almacareer/cookie-consent-manager.svg)](https://www.npmjs.com/package/@almacareer/cookie-consent-manager)
[![CI](https://github.com/lmc-eu/cookie-consent-manager/actions/workflows/test.yaml/badge.svg?branch=main)](https://github.com/lmc-eu/cookie-consent-manager/actions)

# Cookie Consent Manager
Expand Down Expand Up @@ -38,13 +38,13 @@ Load default CSS along with your styles in `<head>`:

```html
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Inter:wght@400;600;700&display=swap">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@lmc-eu/cookie-consent-manager@3/CookieConsentManager.min.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@almacareer/cookie-consent-manager@3/CookieConsentManager.min.css">
```

Load the script and initialize the plugin right before ending `</body>` tag:

```html
<script defer src="https://cdn.jsdelivr.net/npm/@lmc-eu/cookie-consent-manager@3/init.js"></script>
<script defer src="https://cdn.jsdelivr.net/npm/@almacareer/cookie-consent-manager@3/init.js"></script>
<script>
window.addEventListener('DOMContentLoaded', function () {
initCookieConsentManager('demo.example'); // use the name of your service, like jobs.cz, seduo.pl etc.
Expand Down Expand Up @@ -72,8 +72,8 @@ You can load the plugin from a CDN, as in the basic example above.
```html
<!-- Note we use version "cookie-consent-manager@2", which points to the latest version of this series (including feature and bugfix releases) -->
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Inter:wght@400;600;700&display=swap">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@lmc-eu/cookie-consent-manager@3/CookieConsentManager.min.css">
<script defer src="https://cdn.jsdelivr.net/npm/@lmc-eu/cookie-consent-manager@3/init.js"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@almacareer/cookie-consent-manager@3/CookieConsentManager.min.css">
<script defer src="https://cdn.jsdelivr.net/npm/@almacareer/cookie-consent-manager@3/init.js"></script>
```

Alternatively, you can also download the latest version from the [Releases page](https://github.com/lmc-eu/cookie-consent-manager/releases).
Expand All @@ -86,20 +86,20 @@ Once the plugin is loaded, you need to initialize it using `initCookieConsentMan
### Via npm

For projects with their own build process for JavaScript, it is recommended to use the plugin
via npm package [@lmc-eu/cookie-consent-manager](https://www.npmjs.com/package/@lmc-eu/cookie-consent-manager).
via npm package [@almacareer/cookie-consent-manager](https://www.npmjs.com/package/@almacareer/cookie-consent-manager).

1. Add the plugin to your dependencies:
```sh
yarn add @lmc-eu/cookie-consent-manager
yarn add @almacareer/cookie-consent-manager
```
or
```sh
npm install --save @lmc-eu/cookie-consent-manager
npm install --save @almacareer/cookie-consent-manager
```

2. Import the module in your javascript:
```js
import CookieConsentManager from '@lmc-eu/cookie-consent-manager';
import CookieConsentManager from '@almacareer/cookie-consent-manager';
window.addEventListener('DOMContentLoaded', function () {
CookieConsentManager('demo.example'/* , optional plugin configuration */);
Expand All @@ -112,11 +112,11 @@ via npm package [@lmc-eu/cookie-consent-manager](https://www.npmjs.com/package/@
3. Include default CSS in your HTML:
```html
<link rel="stylesheet" href="node_modules/@lmc-eu/cookie-consent-manager/CookieConsentManager.min.css">
<link rel="stylesheet" href="node_modules/@almacareer/cookie-consent-manager/CookieConsentManager.min.css">
```
or in your Sass stylesheet:
```scss
@use "node_modules/@lmc-eu/cookie-consent-manager/CookieConsentManager.css";
@use "node_modules/@almacareer/cookie-consent-manager/CookieConsentManager.css";
```
Please mind the `.css` extension used in the Sass example. Using the provided `.scss` stylesheet is
Expand Down Expand Up @@ -328,7 +328,7 @@ All you need to do is to add this plugin's SCSS to your Sass pipeline and use it
// Add this line anywhere you import other third-party CSS, possibly somewhere close
// to the end of your stylesheet as it contains CSS selectors with high specificity.
@use '@lmc-eu/cookie-consent-manager/CookieConsentManager';
@use '@almacareer/cookie-consent-manager/CookieConsentManager';
```
<details>
Expand Down
2 changes: 1 addition & 1 deletion bin/ci/npm-auth.sh
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ set -o errexit

# Authorise npm for publishing
cat <<NPMRC >> .npmrc
@lmc-eu:registry=https://registry.npmjs.org/
@almacareer:registry=https://registry.npmjs.org/
//registry.npmjs.org/:_authToken=${NPM_TOKEN}
NPMRC

Expand Down
2 changes: 1 addition & 1 deletion examples/webpack-with-esm/index.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// eslint-disable-next-line import/no-unresolved
import { DisplayMode, CookieConsentManager } from '@lmc-eu/cookie-consent-manager';
import { DisplayMode, CookieConsentManager } from '@almacareer/cookie-consent-manager';

const ccmArgs = {
displayMode: DisplayMode.SOFT,
Expand Down
4 changes: 2 additions & 2 deletions examples/webpack-with-esm/package.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
{
"name": "@lmc-eu/cookie-consent-manager-example-module",
"name": "@almacareer/cookie-consent-manager-example-module",
"version": "1.0.0",
"license": "MIT",
"devDependencies": {
"webpack": "^5.63.0",
"webpack-cli": "^4.9.1"
},
"dependencies": {
"@lmc-eu/cookie-consent-manager": "../../dist"
"@almacareer/cookie-consent-manager": "../../dist"
},
"scripts": {
"build": "webpack build --config ./webpack.config.js"
Expand Down
2 changes: 1 addition & 1 deletion examples/webpack-with-typescript/index.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// eslint-disable-next-line import/no-unresolved
import { CookieConsentManager, DisplayMode } from '@lmc-eu/cookie-consent-manager';
import { CookieConsentManager, DisplayMode } from '@almacareer/cookie-consent-manager';

const ccmArgs = {
displayMode: DisplayMode.SOFT,
Expand Down
4 changes: 2 additions & 2 deletions examples/webpack-with-typescript/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@lmc-eu/cookie-consent-manager-example-typescript",
"name": "@almacareer/cookie-consent-manager-example-typescript",
"version": "1.0.0",
"license": "MIT",
"devDependencies": {
Expand All @@ -9,7 +9,7 @@
"webpack-cli": "^4.9.1"
},
"dependencies": {
"@lmc-eu/cookie-consent-manager": "../../dist"
"@almacareer/cookie-consent-manager": "../../dist"
},
"scripts": {
"build": "webpack build --config ./webpack.config.js",
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
{
"name": "@lmc-eu/cookie-consent-manager",
"name": "@almacareer/cookie-consent-manager",
"version": "2.6.0",
"description": "Cookie Consent Manager mainly for Alma Career products",
"keywords": [
"alma-career",
"almacareer",
"lmc-eu",
"cookie",
"consent",
Expand Down

0 comments on commit c54d991

Please sign in to comment.