Skip to content

Commit e46e38a

Browse files
authored
Update README.md
1 parent cfc41f6 commit e46e38a

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

README.md

+18-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,19 @@
1+
12
# UrlHum
2-
The modern, privacy-aware URL Shortener built in PHP.
3+
UrlHum is a modern, privacy-aware and fast URL Shortener built with PHP and the Laravel Framework.
4+
At the moment UrlHum is heavily under development, so we recommend you to don't use it in production.
5+
6+
# What are UrlHum features?
7+
UrlHum provides you advanced privacy-oriented options, such as IP hashing and anonymizing. More, you control pretty anything from the admin panel: you can decide if an unauthenticated user must be able to create a Short URL, if disallowing certain Short URLs from being created and so much more!
8+
9+
UrlHum offers in-depth analytics while still respecting users privacy. You can see clicks, real clicks, countries visits and HTTP referers from the admin panel.
10+
To view an URL analytics, it's enough to add a **+** after the Short URL!
11+
12+
# How to install UrlHum?
13+
You can learn how to install UrlHum following the [documentation](https://urlhum.readme.io/docs/getting-started) we provide.
14+
15+
# Contributing
16+
Thank you for considering contributing to UrlHum. You can send a pull request and we will take a look at it!
17+
18+
# License
19+
UrlHum is open source and is licensed under the [MIT License](https://opensource.org/licenses/MIT)

0 commit comments

Comments
 (0)