Skip to content

Commit

Permalink
Add README.md file with project overview, features, technologies used…
Browse files Browse the repository at this point in the history
…, and instructions for use
  • Loading branch information
SiddharthDhirde committed Mar 30, 2024
1 parent 8fde229 commit 659ead7
Showing 1 changed file with 33 additions and 1 deletion.
34 changes: 33 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,33 @@
# busNoticeBoard
# Notice Board Web Application

This is a simple web application for displaying notices, designed to inform students and teachers about important updates or announcements. The project aims to provide a convenient way to disseminate information within a college or educational institution.

## Features

- Display notice messages on a centralized notice board.
- Automatically rotate through notice messages at regular intervals.
- Support for offline access using Service Worker technology.
- Responsive design for compatibility with different screen sizes.

## Technologies Used

- **HTML**: Used for structuring the content of the web pages.
- **CSS**: Used for styling the user interface and layout.
- **JavaScript**: Used for implementing dynamic behavior and fetching notice messages.
- **Service Worker**: Used to provide offline access to the website.
- **JSON**: Used to store and manage notice messages in a structured format.

## How to Use

1. Clone the repository to your local machine.
2. Open the `index.html` file in a web browser to view the notice board.
3. Notice messages will automatically rotate at regular intervals.
4. To update notice messages, modify the `notices.json` file with new messages.

## Contributions

Contributions to the project are welcome! If you have any ideas for improvements or feature enhancements, feel free to open an issue or submit a pull request.

## License

This project is licensed under the [MIT License](LICENSE).

0 comments on commit 659ead7

Please sign in to comment.