Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
WesleyMcGinn committed Oct 2, 2023
1 parent e11add6 commit 90326c3
Showing 1 changed file with 14 additions and 15 deletions.
29 changes: 14 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,36 +4,35 @@ A free-to-use website with which you can create redirect links of various types,
### URL Parameters
In a URL, there are often parameters. For example, if on pretendExampleSite.com you want to set "color" to 5 and "id" to "something", the URL may look something like this: `pretendExampleSite.com/?color=5&id=something`.

The URL parameters for this website go as follows:
The URL parameters for this website work like this:


| Parameter | What | Example |
| Parameter | What It Is | Example |
| :-: | :-: | :-: |
| m | Message to display | `?m=Hello` |
| m | Message to display (in HTML format) | `?m=Hello` |
| r | Redirect link (MUST INCLUDE PROTOCOL) | `?r=https://earth.google.com/web` |
| c | Background color (top) | `?c=#c0ffc0` |
| C | Background color (bottom) | `?C=#00ff00` |
| c | Background color (top of gradient) | `?c=#c0ffc0` |
| C | Background color (bottom of gradient) | `?C=aquamarine` |
| t | Timed Redirect in seconds | `?t=5` |
| an | Allowed Names | `?an=["bob","joe","nobody"]` |
| ap | Encoded password | `?ap=qr#$$(abb^**@4.2r}..dq` |
| s | Security Token | `?s=557248829011730` |
| an | List of Allowed Names (Will redirect to link for these people, but not others.) | `?an=["bob","joe","nobody"]` |
| ap | Password (This will be made more secure later) | `?ap=qr$$(abb^**@4.2r}..dq` |
| script | Javascript code to run with message display | `?script=alert("Hello.")` |


All typable characters are allowed in the url parameter values except for "?", "&", and "=", since these characters are used for discerning where each parameter is located.
Almost all typable characters are allowed in the url parameter values except for "?", "&", "#", "/", and "=", since these characters are used for discerning where each parameter is located. A UI will be available soon to make it easier to create these links, but for now you can use URL encoding. (exaple: "]" = "%5D")

### Example:
Suppose you entered this parameter list:
```
?r=https://www.youtube.com/watch%3Fv%3DthOifuHs6eY&t=5&c=springgreen&C=forestgreen&s=557248829011730&an=%5B%22RobotMan%22%2C%22Grey%22%2C%22IamCOMPUTER%22%5D
?r=https://www.youtube.com/watch%3Fv%3DthOifuHs6eY&t=5&c=springgreen&C=forestgreen&an=%5B%22Joe%22%2C%22Smith%22%2C%22IamCOMPUTER%22%5D
```
[Try It](https://wesleymcginn.github.io/SnailURL/home.html?r=https://www.youtube.com/watch%3Fv%3DthOifuHs6eY&t=5&c=springgreen&C=forestgreen&s=557248829011730&an=%5B%22RobotMan%22%2C%22Grey%22%2C%22IamCOMPUTER%22%5D)
[Try It](https://wesleymcginn.github.io/SnailURL/home.html?r=https://www.youtube.com/watch%3Fv%3DthOifuHs6eY&t=5&c=springgreen&C=forestgreen&an=%5B%22Joe%22%2C%22Smith%22%2C%22IamCOMPUTER%22%5D)

The SnailURL page would open with a background gradient of spring green to forest green, and an input field to enter your name into would appear with a "Submit" button next to it. If you had already entered your name into SnailURL before, then your name would already be in the input field. If you entered "RobotMan", "Grey", or "IamCOMPUTER", you would be redirected to a specific youtube video after a countdown timer of 5 seconds finished.
The SnailURL page would open with a background gradient of spring green to forest green, and an input field to enter your name into would appear with a "Submit" button next to it. If you had already entered your name into SnailURL before, then your name would already be in the input field. If you entered "Joe", "Smith", or "IamCOMPUTER", you would be redirected to a specific youtube video after a countdown timer of 5 seconds finished.

Currently, the allowed names can be plainly seen in the URL. Later on, however, this parameter will be encrypted. Unfortunately, this has not yet been programmed.

### Upcoming Changes:
- [ ] Enhanced security (encrypted `an` and `ap` parameters),
- [ ] User-friendly link-generator page,
- [ ] Even better aesthetics! (Application of "Snail" from "SnailURL" will be obvious.)
- Enhanced security (encrypted `an` and `ap` parameters),
- User-friendly link-generator page,
- Even better aesthetics! (Application of "Snail" from "SnailURL" will be obvious.)

0 comments on commit 90326c3

Please sign in to comment.