Skip to content

Commit f1a8d40

Browse files
committed
Update readme
1 parent 92c844d commit f1a8d40

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

README.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,51 @@
1+
![ClassClock Icon](./icons/classclockicon-512.png)
2+
13
# ClassClock
4+
5+
6+
## What is ClassClock?
7+
ClassClock is a web app to give students and teachers easy access to:
8+
- current date and time
9+
- daily schedules (You are on the Mon/Tues Schedule)
10+
- the class period you are currently in (i.e. 2nd Period)
11+
- a countdown until class is over
12+
- the generic name of your next class (i.e. 3rd Period)
13+
14+
ClassClock is useful for:
15+
- **Teachers** - to check how much teaching time is left in class
16+
- **Students** - to remind themselves of where they need to be and when
17+
- **Parents** - to see the optimal time to contact their student without interfering with instruction time
18+
- **Everyone** - to have quick and easy access to varied schedules that may otherwise be complicated, confusing or hard to remember
19+
20+
21+
### Upcoming Features
22+
Here are some features to look forward to in a future version:
23+
24+
- [ ] Support for multiple schools (currently only supports one)
25+
- [ ] Detection of block (A/B) schedules
26+
- [ ] Countdown to school breaks (winter break, spriing break, summer .etc)
27+
- [ ] Support for custom schedules (assemblies, parades, combined schedules etc.)
28+
- [ ] The ability to change what is displayed
29+
- [ ] The ability for students to upload their schedules to get more detailed information such as teacher name and room number
30+
31+
32+
33+
34+
## How to install?
35+
36+
ClassTime is a web-based app that can be saved to your phone's home screen or bookmarked in your browser for easy access.
37+
38+
### iOS
39+
40+
1. Navigate to https://classclock.app in Safari (not tested on other browsers)
41+
2. Click the "Share" or "Action" button (it looks like a square with an arrow pointing up out of the top)
42+
3. Click "Add to Home Screen" on the bottom row (you might have to scroll sideways to see it)
43+
4. Click "Done" in the top corner of the screen to add it to your home screen.
44+
45+
46+
### Android
47+
48+
1. Navigate to https://classclock.app (instructions for Google Chrome)
49+
2. Click the "Overflow" button on the top right of your screen (it looks like three vertical dots)
50+
3. Click "Add to Home Screen" button in the menu (it's about 2/3 of the way down)
51+
4. Click "Add" in the dialog box that pops up to add it to your home screen.

0 commit comments

Comments
 (0)