Skip to content

Commit e57661d

Browse files
committed
Update README.md
1 parent 48afab6 commit e57661d

File tree

1 file changed

+26
-3
lines changed

1 file changed

+26
-3
lines changed

README.md

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,20 @@ _This replaces the legacy [url-shortening-api-netlify-supabase](https://github.c
1212

1313
- **URL Shortening**: Convert long URLs into short, manageable links that are easier to share.
1414
- **URL Validation**: Ensures that only valid URLs with proper protocols are processed.
15-
- **Automatic URL Deduplication**: Checks the database to avoid storing duplicate entries for the same URL.
16-
- **High Performance**: Leveraging Netlify Edge Functions combined with the Supabase REST API for high-speed data retrieval and storage.
17-
- **Error Handling**: Robust error handling mechanisms to provide clear feedback on the nature of issues encountered.
15+
- **URL Redirection**: Redirect users to the original long URL based on the short URL.
16+
- **Retrieve Latest Shortened URLs**: Access the most recently created short URLs.
17+
- **URL Count**: Get the total number of URLs shortened.
18+
- **API Versioning**: Retrieve the current version of the API.
19+
- **CORS Support**: Handle cross-origin resource sharing with appropriate headers.
20+
- **Error Handling**: Graceful error handling with appropriate HTTP status codes and error messages.
21+
22+
### **Dependencies**
23+
24+
- **Node.js**: The script runs in a Node.js environment.
25+
- **Deno**: A secure runtime for JavaScript and TypeScript.
26+
- **Supabase (REST API)**: A backend-as-a-service providing a Postgres database, authentication, storage, and more.
27+
- **Netlify Edge Functions**: Serverless functions that run at the edge, closer to your users.
28+
- **multiParser**: Parses multipart form data.
1829

1930
## Endpoints
2031

@@ -107,6 +118,18 @@ Use curl to make a request:
107118
curl http://localhost/version
108119
```
109120

121+
The server responds with:
122+
123+
```bash
124+
{
125+
"name": "url-shortening-api-netlify-edge-supabase",
126+
"version": "0.0.1",
127+
"description": "url-shortening-api-netlify-edge-supabase is a URL shortener service using Netlify Edge Functions and the Supabase REST API.",
128+
"author": "Sam Estrin",
129+
"homepage": "https://github.com/samestrin/url-shortening-api-netlify-edge-supabase#readme"
130+
}
131+
```
132+
110133
## CORS
111134

112135
The server responds with appropriate CORS headers such as Access-Control-Allow-Origin.

0 commit comments

Comments
 (0)