Skip to content

Commit 56cf561

Browse files
committed
Add a readme
1 parent 57ee19f commit 56cf561

1 file changed

Lines changed: 97 additions & 0 deletions

File tree

README.md

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
# WAP.FYI - The Retro Mobile URL Shortener
2+
3+
```
4+
__ ___ _____ ________ ___ __
5+
\ \ / / \| __ \ | ____\ \ / / / /
6+
\ \ /\ / / _ \| |__) | | |__ \ \_/ / / /
7+
\ \/ \/ / /_\ \ ___/ | __| \ / / /
8+
\ /\ /| _ | | | | | | / /
9+
\/ \/ |_| |_|_| |_| |_| /_/
10+
11+
The Link Shortener for the New Millennium!
12+
```
13+
14+
## 🌟 Welcome to WAP.FYI! 🌟
15+
16+
*Shorten your URLs to the power of WAP technology!*
17+
18+
### 📱 What is WAP.FYI?
19+
20+
WAP.FYI is a cutting-edge URL shortener designed for the mobile web revolution! Whether you're browsing on your Nokia 7110, Siemens S35, or that fancy new Windows Mobile device, WAP.FYI has got you covered.
21+
22+
**Features:**
23+
-**WAP Compatible** - Works on ANY WAP-enabled device!
24+
- 🔒 **Proof-of-Work Security** - Gosh the internet got dark and depressing that we need this
25+
- 🎨 **UI** - Beautiful HTML 4.01 Transitional design with classic inset borders
26+
- 📶 **Mobile First** - Auto-detects WAP browsers and serves WML content
27+
28+
### 🚀 Getting Started
29+
30+
Just go to [wap.fyi](http://wap.fyi) on your Windows XP machine.
31+
32+
Or you can run it at home...
33+
34+
#### Prerequisites
35+
- Go 1.24+ (because we're living in the future!)
36+
- A terminal (preferably green text on black background)
37+
- Netscape Navigator 4.0+ or Internet Explorer 5.0+ for the full experience
38+
39+
#### Installation
40+
41+
1. **Clone this repository:**
42+
```bash
43+
git clone https://github.com/bevelgacom/wap.fyi.git
44+
cd wap.fyi
45+
```
46+
47+
2. **Build the application:**
48+
```bash
49+
go build -o server ./
50+
```
51+
52+
3. **Run the server:**
53+
```bash
54+
./server
55+
```
56+
57+
4. **Visit http://localhost:8080** in your browser!
58+
59+
#### Docker Installation (For the Docker Revolution!)
60+
```bash
61+
docker build -t wap.fyi .
62+
docker run -p 8080:8080 wap.fyi
63+
```
64+
65+
### 🎮 How to Use
66+
67+
1. **Visit the ** - Marvel at the retro design!
68+
1. **Enter your long URL** - No more typing on that silly keypad!
69+
1. **Choose a custom path** - Use letters, numbers, underscores, and hyphens only
70+
1. **Solve the challenge** - Because simple math questions aren't hard enough
71+
1. **Get your shortened URL** - Share it with your friends over SMS!
72+
73+
### 📱 WAP Support
74+
75+
WAP.FYI automatically detects WAP browsers by checking for `text/vnd.wap.wml` in the Accept header. WAP users get:
76+
- Custom WML 404 pages
77+
- Automatic redirect to the Bevelgacom WAP portal
78+
- As short as we can get without spending a million on a domain name
79+
80+
### 🎨 Browser Compatibility
81+
82+
**Tested and working on:**
83+
- ✅ Netscape Navigator 4.0+
84+
- ✅ Internet Explorer 5.0+
85+
- ✅ Opera 3.5+
86+
- ✅ Nokia WAP browsers
87+
88+
89+
---
90+
91+
*"Best viewed in Netscape Navigator at 800x600 resolution"*
92+
93+
**© 1999-2025 Bevelgacom - Connecting Generations!**
94+
95+
---
96+
97+
*Visit our Geocities page for more information!*

0 commit comments

Comments
 (0)