Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@rumaan
rumaan committed Jan 4, 2023
1 parent 1cc7bec commit aefe9ac
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 9 deletions.
4 changes: 2 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ or in browser end of `<body>` tag
For some frameworks like [Vue](https://vuejs.org/guide/extras/web-components.html#example-vite-config) for example, you might need to configure the bundler so it plays well with web components.

Framework Usages:
- [Vue](/demo/vue/) - [Demo](https://email-obfuscator-webcomponent-demo.vercel.app/vue/index.html)
- [React](/demo/react/) - [Demo](https://email-obfuscator-webcomponent-demo.vercel.app/react/index.html)
- [Vue](/demo/vue/) · [Demo](https://email-obfuscator-webcomponent-demo.vercel.app/vue/index.html)
- [React](/demo/react/) · [Demo](https://email-obfuscator-webcomponent-demo.vercel.app/react/index.html)

## TODOS

Expand Down
5 changes: 3 additions & 2 deletions lib/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,14 +41,15 @@ or in browser end of `<body>` tag
For some frameworks like [Vue](https://vuejs.org/guide/extras/web-components.html#example-vite-config) for example, you might need to configure the bundler so it plays well with web components.

Framework Usages:
- [Vue](/demo/vue/) - [Demo](https://email-obfuscator-webcomponent-demo.vercel.app/vue/index.html)
- [Vue](/demo/vue/) · [Demo](https://email-obfuscator-webcomponent-demo.vercel.app/vue/index.html)
- [React](/demo/react/) · [Demo](https://email-obfuscator-webcomponent-demo.vercel.app/react/index.html)

## TODOS

- [ ] Expose [slots](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_templates_and_slots) to customise link
- [ ] Export webcomponent types
- [ ] Tests
- [ ] Readme with examples using in React, Vue etc.
- [x] Readme with examples using in React, Vue etc.

## Credits

Expand Down
2 changes: 1 addition & 1 deletion lib/package.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "email-obfuscator-webcomponent",
"version": "0.0.4-beta-3",
"version": "0.0.4-beta-4",
"description": "A simple Web Component that Obfuscates Email address in HTML source.",
"type": "module",
"main": "dist/index.cjs",
Expand Down
6 changes: 3 additions & 3 deletions package-lock.json
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "email-obfuscator-webcomponent-demo",
"version": "0.0.4-beta-4",
"version": "0.0.4-beta-5",
"description": "Web Component that Obfuscates Email address in HTML source.",
"scripts": {
"dev": "npm run build:lib && npm install && vite --config ./demo/vite.config.ts",
Expand Down

1 comment on commit aefe9ac

@vercel
Copy link

@vercel vercel bot commented on aefe9ac Jan 4, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

email-obfuscator-webcomponent-demo – ./

email-obfuscator-webcomponent-demo.vercel.app
email-obfuscator-webcomponent-demo-git-main-rumaan.vercel.app
email-obfuscator-webcomponent-demo-rumaan.vercel.app

Please sign in to comment.