Merge pull request #1 from AlejandroRM-DEV/chore/release

Chore/release
AlejandroRM-DEV · Aug 30, 2024 · 282f7bb · 282f7bb
2 parents d1cebf7 + fce8cea
commit 282f7bb
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 75 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,62 +0,0 @@
-
-
-## 1.2.0 (2024-08-30)
-
-
-### Features
-
-* **Media queries:** :sparkles: Add hooks useMediaQuery and useMediaQueries with tests and demo ([b97032e](https://github.com/AlejandroRM-DEV/mx-hooks/commit/b97032e0672623fed5ce102293f41a12990d4493))
-
-
-### Miscellaneous Chores
-
-* :bookmark: Release ([1eb96a8](https://github.com/AlejandroRM-DEV/mx-hooks/commit/1eb96a89262fb0c85f59b30dfea333174115749e))
-* :rocket: Update package.json ([476b3e5](https://github.com/AlejandroRM-DEV/mx-hooks/commit/476b3e5e705a4c884d46b32abc069aef84dfecff))
-* release v1.1.0 [skip ci] ([9187bc1](https://github.com/AlejandroRM-DEV/mx-hooks/commit/9187bc11d913861877a6767c092b60f928a045df))
-
-
-### Documentation
-
-* :memo: Updated docs and configs ([2580da4](https://github.com/AlejandroRM-DEV/mx-hooks/commit/2580da432d75f015a36de54182cf6b379c76c4df))
-* create .all-contributorsrc [skip ci] ([776ff10](https://github.com/AlejandroRM-DEV/mx-hooks/commit/776ff10e72ca0f5f166b149d9ca056fb1e156707))
-* update README.md [skip ci] ([1f486d5](https://github.com/AlejandroRM-DEV/mx-hooks/commit/1f486d5c2247741d819c37f9e3b78451d1e2362e))
-
-
-### Build System
-
-* :heavy_plus_sign: Adds jsdom ([7c6210b](https://github.com/AlejandroRM-DEV/mx-hooks/commit/7c6210bf1214c99bcef35fd4e7db6808bda42f17))
-
-
-### Continuous Integration
-
-* :green_heart: add registry-url ([ea8e208](https://github.com/AlejandroRM-DEV/mx-hooks/commit/ea8e2087d9e6539e0d6cf6f0a93cb785bec7f95d))
-* :green_heart: fix ([b3a5286](https://github.com/AlejandroRM-DEV/mx-hooks/commit/b3a528694841f993ed8674846a979e440f5121d5))
-
-## 1.1.0 (2024-08-30)
-
-
-### Features
-
-* **Media queries:** :sparkles: Add hooks useMediaQuery and useMediaQueries with tests and demo ([b97032e](https://github.com/AlejandroRM-DEV/mx-hooks/commit/b97032e0672623fed5ce102293f41a12990d4493))
-
-
-### Miscellaneous Chores
-
-* :bookmark: Release ([1eb96a8](https://github.com/AlejandroRM-DEV/mx-hooks/commit/1eb96a89262fb0c85f59b30dfea333174115749e))
-* :rocket: Update package.json ([476b3e5](https://github.com/AlejandroRM-DEV/mx-hooks/commit/476b3e5e705a4c884d46b32abc069aef84dfecff))
-
-
-### Documentation
-
-* :memo: Updated docs and configs ([2580da4](https://github.com/AlejandroRM-DEV/mx-hooks/commit/2580da432d75f015a36de54182cf6b379c76c4df))
-
-
-### Build System
-
-* :heavy_plus_sign: Adds jsdom ([7c6210b](https://github.com/AlejandroRM-DEV/mx-hooks/commit/7c6210bf1214c99bcef35fd4e7db6808bda42f17))
-
-
-### Continuous Integration
-
-* :green_heart: add registry-url ([ea8e208](https://github.com/AlejandroRM-DEV/mx-hooks/commit/ea8e2087d9e6539e0d6cf6f0a93cb785bec7f95d))
-* :green_heart: fix ([b3a5286](https://github.com/AlejandroRM-DEV/mx-hooks/commit/b3a528694841f993ed8674846a979e440f5121d5))

diff --git a/README.md b/README.md
@@ -1,16 +1,24 @@
-# mx-hooks
+# React Media Queries
+
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
 [![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
-`mx-hooks` is a React hooks library that provides useful custom hooks for responsive design and media queries.
+`react-media-queries` is a React hooks library that provides useful custom hooks for responsive design and media queries.
 
 ## Installation
 
 ```bash
-npm install mx-hooks
+npm i @alejandrorm-dev/react-media-queries
 ```
 
+## Demo
+
+
+https://github.com/user-attachments/assets/dd7719a8-a3bd-4da5-93c2-126bdfc8ceb7
+
+
+
 ## Hooks
 
 ### useMediaQuery
@@ -25,11 +33,7 @@ import { useMediaQuery } from 'mx-hooks';
 function MyComponent() {
   const isLargeScreen = useMediaQuery('(min-width: 1200px)');
 
-  return (
-    <div>
-      {isLargeScreen ? 'Large screen' : 'Small screen'}
-    </div>
-  );
+  return <div>{isLargeScreen ? 'Large screen' : 'Small screen'}</div>;
 }
 ```
 
@@ -90,6 +94,7 @@ This project is licensed under the MIT License.
 ## Contributing
 
 Contributions are welcome! Please feel free to submit a Pull Request.
+
 ## Contributors ✨
 
 Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
@@ -110,4 +115,4 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 
-This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
diff --git a/package.json b/package.json
@@ -1,8 +1,8 @@
 {
-  "name": "@alejandrorm-dev/mx-hooks",
-  "version": "1.2.0",
+  "name": "@alejandrorm-dev/react-media-queries",
+  "version": "1.0.0",
   "private": false,
-  "description": "Custom React hooks for managing state and effects in a more modular way",
+  "description": "React hooks library that provides useful custom hooks for responsive design and media queries.",
   "main": "index.js",
   "type": "module",
   "scripts": {
@@ -16,8 +16,12 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/AlejandroRM-DEV/mx-hooks.git"
+    "url": "https://github.com/AlejandroRM-DEV/react-media-queries.git"
   },
+  "bugs": {
+    "url": "https://github.com/AlejandroRM-DEV/react-media-queries/issues"
+  },
+  "homepage": "https://github.com/AlejandroRM-DEV/react-media-queries#readme",
   "keywords": [
     "react",
     "hooks",