From 5832a578fa8d80f2ca58f22f0bbdc9e4f4f0d7c2 Mon Sep 17 00:00:00 2001 From: Dan Lapteacru Date: Tue, 3 Sep 2024 20:04:58 +0300 Subject: [PATCH] transfer package ownership and bump version --- README.md | 25 +++++++++++++++++++------ package.json | 7 +++++-- 2 files changed, 24 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index bfa0b45..677c630 100644 --- a/README.md +++ b/README.md @@ -15,23 +15,36 @@ ## Installation -Install **bud-favicons** to your project. +Install **@itinerisltd/bud-favicons** to your project. Yarn: ```sh -yarn add bud-favicons --dev +yarn add @itinerisltd/bud-favicons --dev ``` npm: ```sh -npm install bud-favicons --save-dev +npm install @itinerisltd/bud-favicons --save-dev ``` ## Configuration -**bud-favicons** works with zero configuration. But there is a robust and developer friendly configuration API should you need to make a modification to the provided defaults. +At the top of your `bud.config.ts` file, import the extension: + +```ts title=bud.config.ts +import BudFavicons from "@itinerisltd/bud-favicons"; +``` + +Then, add the extension to your Bud instance: + +```ts title=bud.config.ts +bud + .use(BudFavicons); +``` + +**@itinerisltd/bud-favicons** works with zero configuration. But there is a robust and developer friendly configuration API should you need to make a modification to the provided defaults. You can see the full list of options in the [favicons documentation](https://github.com/itgalaxy/favicons#usage). ## Default configuration @@ -55,9 +68,9 @@ const options = { }; ``` -## Configuration with `bud.favicons.config` +## Configuration with `bud.favicons.setup` -You can configure `favicons` with the `bud.favicons` method: +You can configure `favicons` with the `bud.favicons.setup` method: ```ts title=bud.config.ts bud.favicons.setup({ diff --git a/package.json b/package.json index 7afd3ed..172c84d 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { - "name": "bud-favicons", - "version": "0.0.15", + "name": "@itinerisltd/bud-favicons", + "version": "0.1.0", "description": "Bud.js extension to automatically generate favicons.", "main": "index.js", "license": "MIT", @@ -10,6 +10,9 @@ "url": "https://github.com/ItinerisLtd/bud-favicons.git", "directory": "sources/bud-favicons" }, + "publishConfig": { + "access": "public" + }, "bugs": "https://github.com/ItinerisLtd/bud-favicons/issues", "keywords": [ "bud",