SinTan1729/chhoto-url
SinTan1729/chhoto-url
1
0
Fork 0
mirror of https://github.com/SinTan1729/chhoto-url synced 2025-04-28 11:56:52 -05:00
Code Issues Releases Activity

docs: Small changes in the README

Browse source
This commit is contained in:
Sayantan Santra 2025-04-23 16:07:32 -05:00
parent 084334cd11
commit 3aa8884676
Signed by: SinTan1729
GPG key ID: 0538DD402EA50898
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -38,9 +38,9 @@ for small. URL means, well... URL. So the name simply means Small URL.
# Features # Features
- Shortens URLs of any length to a randomly generated link. - Shortens URLs of any length to a randomly generated link.
- (Optional) Allows you to specify the shortened URL instead of the generated - (Optional) Allows you to specify the shortened URL instead of the generated
one. (It's surprisingly missing in a surprising number of alternatives.) one. (It's missing in a surprising number of alternatives.)
- Opening the shortened URL in your browser will instantly redirect you - Opening the shortened URL in your browser will instantly redirect you
to the correct long URL. (So no stupid redirecting pages.) to the correct long URL. (So no stupid redirection pages.)
- Super lightweight and snappy. (The docker image is only ~6MB and RAM uasge - Super lightweight and snappy. (The docker image is only ~6MB and RAM uasge
stays under 5MB under normal use.) stays under 5MB under normal use.)
- Counts number of hits for each short link in a privacy respecting way - Counts number of hits for each short link in a privacy respecting way
@ -52,8 +52,8 @@ for small. URL means, well... URL. So the name simply means Small URL.
- Allows setting the URL of your website, in case you want to conveniently - Allows setting the URL of your website, in case you want to conveniently
generate short links locally. generate short links locally.
- Links are stored in an SQLite database. - Links are stored in an SQLite database.
- Available as a Docker container. - Available as a Docker container with a provided compose file.
- Backend written in Rust using [Actix](https://actix.rs/), frontend - Backend written in Rust using [Actix](https://actix.rs/), and frontend
written in plain HTML and vanilla JS, using [Pure CSS](https://purecss.io/) written in plain HTML and vanilla JS, using [Pure CSS](https://purecss.io/)
for styling. for styling.
- Uses very basic authentication using a provided password. It's not encrypted in transport. - Uses very basic authentication using a provided password. It's not encrypted in transport.
@ -61,15 +61,15 @@ for small. URL means, well... URL. So the name simply means Small URL.
encrypt the connection by SSL. encrypt the connection by SSL.
# Bloat that will not be implemented # Bloat that will not be implemented
- Tracking or spying of any kind. The only logs that still exist are - **Tracking or spying of any kind.** The only logs that still exist are
errors printed to stderr and the basic logging (only warnings) provided by the errors printed to stderr and the basic logging (only warnings) provided by the
[`env_logger`](https://crates.io/crates/env_logger) crate. [`env_logger`](https://crates.io/crates/env_logger) crate.
- User management. If you need a shortener for your whole organization, either - **User management.** If you need a shortener for your whole organization, either
run separate containers for everyone or use something else. run separate containers for everyone or use something else.
- Cookies, newsletters, "we value your privacy" popups or any of the multiple - **Cookies, newsletters**, "we value your privacy" popups or any of the multiple
other ways modern web shows how anti-user it is. We all hate those, and they're other ways modern web shows how anti-user it is. We all hate those, and they're
not needed here. not needed here.
- Paywalls or messages begging for donations. If you want to support me (for - **Paywalls** or messages begging for donations. If you want to support me (for
whatever reason), you can message me through GitHub issues. whatever reason), you can message me through GitHub issues.
# Screenshots # Screenshots