Skip to content

Commit

Permalink
feat: change doc and icon
Browse files Browse the repository at this point in the history
  • Loading branch information
tiavina-mika committed Jun 19, 2024
1 parent 81881b4 commit 1966479
Show file tree
Hide file tree
Showing 36 changed files with 8 additions and 41 deletions.
3 changes: 3 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,6 @@ jobs:
run: yarn npm publish
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

- run: echo "Published to NPM 🚀- https://www.npmjs.com/package/${{ github.event.repository.name }}"

2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ To instead test a "built" version of this package which is installed into an "ex
When a new version should be cut since some new changes have landed on the `main` branch, do the following to publish it:

1. Go to the `main` branch and pull in the latest changes.
2. Commit change using (commit convention)[https://www.conventionalcommits.org/en/v1.0.0-beta.4/]
2. Commit change using (commit convention)[https://www.conventionalcommits.org]
3. Push the commit (ex: `git push origin main`)
4. The `release.yml` GitHub Actions workflow will auto-generate a tag, change log, release note and a PR branch
5. The `automerge.yml` GitHub Actions workflow will merge and delete the PR branch
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,11 +118,11 @@ function App() {
/>
```

See [`example/App.tsx`](https://github.com/tiavina-mika/mui-password-strength-input/tree/main/example) for a more example of using `PasswordStrengthInput`.
See [`here`](https://github.com/tiavina-mika/mui-password-strength-input/tree/main/example) for more examples that use `PasswordStrengthInput`.

## Props

|props |type | Default value | Description |
|Props |Type | Default value | Description |
|----------------|-------------------------------|-----------------------------|-----------------------------|
|options|`Options`|null|Options to override colors and labels of each strength
|barClassName|`string`|empty|custom class name of the each bar indicator
Expand Down
Binary file added example/public/favicon.ico
Binary file not shown.
1 change: 0 additions & 1 deletion example/public/favicon.svg

This file was deleted.

1 change: 0 additions & 1 deletion example/public/images/logo-white.svg

This file was deleted.

Binary file removed example/public/images/logo.png
Binary file not shown.
1 change: 0 additions & 1 deletion example/public/images/logo.svg

This file was deleted.

1 change: 0 additions & 1 deletion example/public/vite.svg

This file was deleted.

3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,10 @@
"version": "0.1.7",
"description": "A Material-UI password input with password strength indicator",
"keywords": [
"react",
"mui",
"password",
"check-passowrd-complexity",
"check-passworrd-complexity",
"password-strength",
"material-ui",
"password-input",
Expand Down
Binary file added public/favicon.ico
Binary file not shown.
1 change: 0 additions & 1 deletion public/favicon.svg

This file was deleted.

1 change: 0 additions & 1 deletion public/icons/align-center.svg

This file was deleted.

1 change: 0 additions & 1 deletion public/icons/align-justify.svg

This file was deleted.

1 change: 0 additions & 1 deletion public/icons/align-left.svg

This file was deleted.

1 change: 0 additions & 1 deletion public/icons/align-right.svg

This file was deleted.

Loading

0 comments on commit 1966479

Please sign in to comment.