Skip to content

Commit

Permalink
docs(readme): update package name references to include scope @le-pepe
Browse files Browse the repository at this point in the history
…for clarity and consistency

docs(readme): change image syntax for logo to improve compatibility across markdown renderers
docs(readme): mark completed tasks in TODO list for better project tracking
  • Loading branch information
le-pepe committed Oct 5, 2024
1 parent 916c757 commit dc4dbaa
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
[![License][license-src]][license-href]
[![Built With Stencil](https://img.shields.io/badge/-Built%20With%20Stencil-16161d.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDE5LjIuMSwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9IkxheWVyXzEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHg9IjBweCIgeT0iMHB4IgoJIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBzdHlsZT0iZW5hYmxlLWJhY2tncm91bmQ6bmV3IDAgMCA1MTIgNTEyOyIgeG1sOnNwYWNlPSJwcmVzZXJ2ZSI%2BCjxzdHlsZSB0eXBlPSJ0ZXh0L2NzcyI%2BCgkuc3Qwe2ZpbGw6I0ZGRkZGRjt9Cjwvc3R5bGU%2BCjxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik00MjQuNywzNzMuOWMwLDM3LjYtNTUuMSw2OC42LTkyLjcsNjguNkgxODAuNGMtMzcuOSwwLTkyLjctMzAuNy05Mi43LTY4LjZ2LTMuNmgzMzYuOVYzNzMuOXoiLz4KPHBhdGggY2xhc3M9InN0MCIgZD0iTTQyNC43LDI5Mi4xSDE4MC40Yy0zNy42LDAtOTIuNy0zMS05Mi43LTY4LjZ2LTMuNkgzMzJjMzcuNiwwLDkyLjcsMzEsOTIuNyw2OC42VjI5Mi4xeiIvPgo8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNDI0LjcsMTQxLjdIODcuN3YtMy42YzAtMzcuNiw1NC44LTY4LjYsOTIuNy02OC42SDMzMmMzNy45LDAsOTIuNywzMC43LDkyLjcsNjguNlYxNDEuN3oiLz4KPC9zdmc%2BCg%3D%3D&colorA=16161d&style=flat-square)](https://stenciljs.com)

![Snow Effect](./src/images/logo-light.svg "Snow Effect")
[//]: # (![Snow Effect](./src/images/logo-light.svg "Snow Effect"))
<img src="./src/images/logo-light.svg" alt="Snow Effect" width="50%">

# snow-effect

A web component built with StencilJS that generates falling snowflakes, providing an easy-to-use snow effect for any website.

Expand All @@ -25,7 +25,7 @@ You can use the `snow-effect` custom element in your HTML. It allows customizati
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Snow Effect Demo</title>
<script type="module" src="https://unpkg.com/snow-effect"></script>
<script type="module" src="https://unpkg.com/@le-pepe/snow-effect"></script>
<style>
body {
font-family: Arial, sans-serif;
Expand Down Expand Up @@ -119,17 +119,17 @@ This project is licensed under the MIT License. See the [LICENSE](LICENSE) file

## TODO

- [ ] Get a logo
- [ ] Support for node module
- [x] Get a logo
- [x] Support for node module
- [ ] Add frameworks wrapper (React, Angular, Vue)


<!-- Placeholder for logo until it is created -->
[npm-version-src]: https://img.shields.io/npm/v/snow-effect/latest.svg?style=flat&colorA=020420&colorB=00DC82
[npm-version-href]: https://npmjs.com/package/snow-effect
[npm-version-src]: https://img.shields.io/npm/v/@le-pepe/snow-effect/latest.svg?style=flat&colorA=020420&colorB=00DC82
[npm-version-href]: https://npmjs.com/package/@le-pepe/snow-effect

[npm-downloads-src]: https://img.shields.io/npm/dm/snow-effect.svg?style=flat&colorA=020420&colorB=00DC82
[npm-downloads-href]: https://npmjs.com/package/snow-effect
[npm-downloads-src]: https://img.shields.io/npm/dm/@le-pepe/snow-effect.svg?style=flat&colorA=020420&colorB=00DC82
[npm-downloads-href]: https://npmjs.com/package/@le-pepe/snow-effect

[license-src]: https://img.shields.io/npm/l/snow-effect.svg?style=flat&colorA=020420&colorB=00DC82
[license-href]: https://npmjs.com/package/snow-effect
[license-src]: https://img.shields.io/npm/l/@le-pepe/snow-effect.svg?style=flat&colorA=020420&colorB=00DC82
[license-href]: https://npmjs.com/package/@le-pepe/snow-effect

0 comments on commit dc4dbaa

Please sign in to comment.