Skip to content

Commit

Permalink
Merge pull request #394 from db-ui/chore-dbui-change-dbux
Browse files Browse the repository at this point in the history
chore: change package name from db-ui to db-ux
  • Loading branch information
nmerget authored Jan 9, 2025
2 parents 88cf923 + acd1ea1 commit aff8620
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ To check the complete CLI API goto [API](./docs/API.md).
For icon font generation each icon should be a single path. To clean up your icons run:

```shell
npx @db-ui/icon-font-tools clean-icons --src ./my-path-to/icons
npx @db-ux/icon-font-tools clean-icons --src ./my-path-to/icons
```

We use [svg-fixer](https://github.com/oslllo/svg-fixer) to clean up the icons. This will slightly increase the file size but ensures that the icons are displayed correctly.
Expand All @@ -21,7 +21,7 @@ We use [svg-fixer](https://github.com/oslllo/svg-fixer) to clean up the icons. T
For this run:

```shell
npx @db-ui/icon-font-tools generate-icon-fonts --src ./my-path-to/icons --fontName my-name
npx @db-ux/icon-font-tools generate-icon-fonts --src ./my-path-to/icons --fontName my-name
```

We search for all `**/*.svg` files inside the `--src` directory and create a new icon font with the provided name. You can preview all generated icons here: `./my-path-to/icons/fonts/all/index.html`.
Expand All @@ -31,7 +31,7 @@ We search for all `**/*.svg` files inside the `--src` directory and create a new
For more information run:

```shell
npx @db-ui/icon-font-tools --help
npx @db-ux/icon-font-tools --help
```

### How to use
Expand Down
2 changes: 1 addition & 1 deletion docs/API.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# API - @db-ui/icon-font-tools
# API - @db-ux/icon-font-tools

CLI for generating or manipulating icon fonts from SVG files.

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": "@db-ui/icon-font-tools",
"name": "@db-ux/icon-font-tools",
"version": "0.0.0",
"description": "A toolset for generating or manipulating icon fonts from SVG files.",
"type": "module",
Expand All @@ -9,7 +9,7 @@
},
"license": "Apache-2.0",
"bin": {
"@db-ui/icon-font-tools": "dist/index.js"
"@db-ux/icon-font-tools": "dist/index.js"
},
"main": "dist/index.js",
"files": [
Expand Down
2 changes: 1 addition & 1 deletion src/data.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { gifAction } from "./commands/generate-icon-fonts";
import {cleanIconsOptions} from "./commands/clean-icons/data";
import {cleanIconAction} from "./commands/clean-icons";

export const programName = "@db-ui/icon-font-tools";
export const programName = "@db-ux/icon-font-tools";
export const programDescription =
"CLI for generating or manipulating icon fonts from SVG files.";

Expand Down

0 comments on commit aff8620

Please sign in to comment.