Skip to content

Commit

Permalink
touchup readme
Browse files Browse the repository at this point in the history
  • Loading branch information
vincerubinetti authored Aug 29, 2024
1 parent a4020f5 commit 366ce49
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 3 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,20 @@
# Screensaver

[⭐️ **Open the screensaver** ⭐️](https://cu-dbmi.github.io/screensaver)
[⭐️ **OPEN THE SCREENSAVER** ⭐️](https://cu-dbmi.github.io/screensaver) and fullscreen your browser!

Overlay text by adding a `text` parameter to the URL.
### Add text

Add text to the visualization by adding a `text` parameter to the URL.
Use `\n` for new lines.
Example: `/screensaver?text=DBMI \n Dept. of Biomedical Informatics`.

Example:
[https://cu-dbmi.github.io/screensaver?text=DBMI \n Dept. of Biomedical Informatics](https://cu-dbmi.github.io/screensaver/?text=DBMI%20\n%20Dept.%20of%20Biomedical%20Informatics)

### Other customization

Shapes, colors, and other settings customizable in source code.
Time-consuming calculations are cached indefinitely in `localStorage`, so clear this if making changes code.

### Acknowledgements

3d models courtesy of https://poly.pizza/
6 changes: 6 additions & 0 deletions index.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
<!doctype html>
<html>
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />

<title>Screensaver</title>

<script
src="https://unpkg.com/[email protected]/dist/gsap.min.js"
crossorigin="anonymous"
Expand Down

0 comments on commit 366ce49

Please sign in to comment.