@h3ravel/url 1.0.1 → 1.0.2

package/README.md

@@ -1,6 +1,20 @@
-# @h3ravel/url
+<div align="center">
+  <a href="https://h3ravel.toneflix.net"  target="_blank">
+    <img src="https://raw.githubusercontent.com/h3ravel/assets/refs/heads/main/logo-full.svg" width="200" alt="H3ravel Logo">
+  </a>
+  <h1 align="center"><a href="https://h3ravel.toneflix.net/guide/urls">H3ravel Url</a></h1>
 
-Request-aware URI builder and URL manipulation utilities for H3ravel framework.
+[![Framework][ix]][lx]
+[![URL Package Version][i1]][l1]
+[![Downloads][d1]][l1]
+[![Tests][tei]][tel]
+[![License][lini]][linl]
+
+</div>
+
+# About H3ravel/url
+
+Request-aware URI builder and URL manipulation utilities for [H3ravel](https://h3ravel.toneflix.net) framework.
 
 ## Installation
 
@@ -21,19 +35,19 @@ npm install @h3ravel/url
 ### Basic URL Creation
 
 ```typescript
-import { Url } from '@h3ravel/url'
+import { Url } from '@h3ravel/url';
 
 // From string
-const url = Url.of('https://example.com/path')
+const url = Url.of('https://example.com/path');
 
 // From path relative to app URL
-const url = Url.to('/users')
+const url = Url.to('/users');
 
 // From named route
-const url = Url.route('users.show', { id: 1 })
+const url = Url.route('users.show', { id: 1 });
 
 // From controller action
-const url = Url.action('UserController@index')
+const url = Url.action('UserController@index');
 ```
 
 ### Fluent Builder API
@@ -46,7 +60,7 @@ const url = Url.of('https://example.com')
   .withPath('/users')
   .withQuery({ page: 2 })
   .withFragment('section-1')
-  .toString()
+  .toString();
 // -> "http://test.com:8000/users?page=2#section-1"
 ```
 
@@ -54,29 +68,33 @@ const url = Url.of('https://example.com')
 
 ```typescript
 // Get current URL
-url().current()
+url().current();
 
 // Get full URL with query string
-url().full()
+url().full();
 
 // Get previous URL
-url().previous()
+url().previous();
 
 // Get previous path only
-url().previousPath()
+url().previousPath();
 
 // Get current query parameters
-url().query()
+url().query();
 ```
 
 ### Signed URLs
 
 ```typescript
 // Create signed route URL
-const signedUrl = Url.signedRoute('users.show', { id: 1 })
+const signedUrl = Url.signedRoute('users.show', { id: 1 });
 
 // Create temporary signed route URL (expires in 5 minutes)
-const tempUrl = Url.temporarySignedRoute('users.index', {}, Date.now() + 300000)
+const tempUrl = Url.temporarySignedRoute(
+  'users.index',
+  {},
+  Date.now() + 300000
+);
 ```
 
 ## API Reference
@@ -108,6 +126,28 @@ const tempUrl = Url.temporarySignedRoute('users.index', {}, Date.now() + 300000)
 - `previousPath()` - Get previous request path
 - `query()` - Get current query parameters
 
+## Contributing
+
+Thank you for considering contributing to the H3ravel framework! The [Contribution Guide](https://h3ravel.toneflix.net/contributing) can be found in the H3ravel documentation and will provide you with all the information you need to get started.
+
+## Code of Conduct
+
+In order to ensure that the H3ravel community is welcoming to all, please review and abide by the [Code of Conduct](#).
+
+## Security Vulnerabilities
+
+If you discover a security vulnerability within H3ravel, please send an e-mail to Legacy via hamzas.legacy@toneflix.ng. All security vulnerabilities will be promptly addressed.
+
 ## License
 
-MIT
+The H3ravel framework is open-sourced software licensed under the [MIT license](LICENSE).
+
+[ix]: https://img.shields.io/npm/v/%40h3ravel%2Fcore?style=flat-square&label=Framework&color=%230970ce
+[lx]: https://www.npmjs.com/package/@h3ravel/core
+[i1]: https://img.shields.io/npm/v/%40h3ravel%2Furl?style=flat-square&label=@h3ravel/url&color=%230970ce
+[l1]: https://www.npmjs.com/package/@h3ravel/url
+[d1]: https://img.shields.io/npm/dt/%40h3ravel%2Furl?style=flat-square&label=Downloads&link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2F%40h3ravel%2Furl
+[linl]: https://github.com/h3ravel/framework/blob/main/LICENSE
+[lini]: https://img.shields.io/github/license/h3ravel/framework
+[tel]: https://github.com/h3ravel/framework/actions/workflows/test.yml
+[tei]: https://github.com/h3ravel/framework/actions/workflows/test.yml/badge.svg

package/package.json

@@ -1,7 +1,12 @@
 {
   "name": "@h3ravel/url",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Request-aware URI builder and URL manipulation utilities for H3ravel.",
+  "h3ravel": {
+    "providers": [
+      "UrlServiceProvider"
+    ]
+  },
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -39,11 +44,11 @@
     "builder"
   ],
   "dependencies": {
-    "@h3ravel/support": "^0.14.0",
-    "@h3ravel/shared": "^0.22.1"
+    "@h3ravel/support": "^0.14.1",
+    "@h3ravel/shared": "^0.22.2"
   },
   "peerDependencies": {
-    "@h3ravel/core": "^1.15.0",
+    "@h3ravel/core": "^1.16.0",
     "@h3ravel/http": "^11.3.3"
   },
   "devDependencies": {