Skip to content

Commit

Permalink
docs: add info about org name
Browse files Browse the repository at this point in the history
  • Loading branch information
tassioFront committed Nov 9, 2024
1 parent 5e197fe commit 46f9e83
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 17 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@

This project was generated as a developer's utility belt, where they might find solutions to be used independently on the system solution (business-wise) and js framework.


*Enjoy it? Don't forget to starring! ⭐*

_Enjoy it? Don't forget to starring! ⭐_

## Project structure

Expand All @@ -23,12 +21,16 @@ It's a monorepo with npm packages, all installable independently

## Installing utility packages

NPM packages are available on npmjs.com, so you can install them using npm or yarn and following the anatomy `utility-PACKAGE_NAME`. Ex:
NPM packages are available on npmjs.com, so you can install them using npm or yarn and following the anatomy `@openish-u/PACKAGE_NAME`. Ex:

```bash
npm i utility-http-front-cache
npm i @openish-u/http-front-cache
```

```bash
yarn add utility-storagefy
yarn add @openish-u/storagefy
```

## Migration from utility prefix to openish-u

If you are using the old prefix `utility-PACKAGE-NAME` you can migrate to the new prefix `@openish-u/PACKAGE-NAME` safely. The packages are the same, only the prefix has changed.
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"description": "A collection of utilities",
"private": true,
"dependencies": {
"@commitlint/cli": "^17.4.3",
"@commitlint/cli": "^17.4.3",
"@commitlint/config-conventional": "^17.4.3",
"@commitlint/config-nx-scopes": "^17.4.3",
"@commitlint/cz-commitlint": "^17.4.2",
Expand All @@ -28,6 +28,7 @@
"@nrwl/linter": "15.9.7",
"@nrwl/nx-plugin": "15.9.7",
"@nrwl/workspace": "15.9.7",
"@openish-u/dependabot-pr-manager": "^5.0.0",
"@swc-node/register": "^1.4.2",
"@swc/cli": "~0.1.55",
"@swc/core": "^1.2.173",
Expand All @@ -49,7 +50,6 @@
"semantic-release-plus": "^20.0.0",
"ts-jest": "28.0.8",
"ts-node": "10.9.2",
"typescript": "4.9.5",
"utility-dependabot-pr-manager": "2.1.0"
"typescript": "4.9.5"
}
}
16 changes: 8 additions & 8 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -2503,6 +2503,14 @@
dependencies:
"@octokit/openapi-types" "^16.0.0"

"@openish-u/dependabot-pr-manager@^5.0.0":
version "5.0.0"
resolved "https://registry.yarnpkg.com/@openish-u/dependabot-pr-manager/-/dependabot-pr-manager-5.0.0.tgz#b8f0141a97a8811292f3cec205de0aa36c09e454"
integrity sha512-7nRv1N2//y85chG0vGLA9Wrf5mstjXzwigNc02+6CXZk+aQAIWY2iC02RUQoJo6BepqZNH7vSA0wrsqyMHVKdA==
dependencies:
"@octokit/rest" "19.0.7"
yargs "17.6.2"

"@parcel/watcher@2.0.4":
version "2.0.4"
resolved "https://registry.yarnpkg.com/@parcel/watcher/-/watcher-2.0.4.tgz#f300fef4cc38008ff4b8c29d92588eced3ce014b"
Expand Down Expand Up @@ -10563,14 +10571,6 @@ util-deprecate@^1.0.1, util-deprecate@^1.0.2, util-deprecate@~1.0.1:
resolved "https://registry.yarnpkg.com/util-deprecate/-/util-deprecate-1.0.2.tgz#450d4dc9fa70de732762fbd2d4a28981419a0ccf"
integrity sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw==

utility-dependabot-pr-manager@2.1.0:
version "2.1.0"
resolved "https://registry.yarnpkg.com/utility-dependabot-pr-manager/-/utility-dependabot-pr-manager-2.1.0.tgz#97b2b11885ab62b601e3deaf11b632a05aa50307"
integrity sha512-KedP9cpV4ldLi5fMvK//ITN744Rw0I0pErfLEJ2bSTM6Qq7UBL8twV5NqIquafS8Aozs+0QyKOSrMLPxoCZKSQ==
dependencies:
"@octokit/rest" "19.0.7"
yargs "17.6.2"

uuid@^3.3.2:
version "3.4.0"
resolved "https://registry.yarnpkg.com/uuid/-/uuid-3.4.0.tgz#b23e4358afa8a202fe7a100af1f5f883f02007ee"
Expand Down

0 comments on commit 46f9e83

Please sign in to comment.