Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
TheOpenInnovator authored Oct 6, 2024
1 parent 4ffa4dd commit 57f4d17
Showing 1 changed file with 113 additions and 1 deletion.
114 changes: 113 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,113 @@
# Zen-Note
# Zen-Note

### README for Zen Note Journal Web Application

# Zen Note

**Zen Note** is an interactive journal web application that allows users to record their daily learnings in a visually appealing and easy-to-use platform. It features a professional design with light and dark modes, glassmorphism effects, and emoji-driven actions. Users can add, view, and delete learnings, and even generate beautiful snapshots of their entries with the option to download or copy them.

---

## Features

1. **Daily Learnings Entry**:
- Users can enter their daily learnings.
- Learnings are displayed date-wise, with the latest entries shown at the top.
- Only one date heading per day is displayed, under which all the learnings of that day are listed.

2. **Delete Functionality**:
- Instead of a "delete" button, a bin emoji 🗑️ is displayed for each entry. Clicking it asks for confirmation before deleting the entry.

3. **Snapshot Creation**:
- Next to each entry, a snapshot emoji 📷 allows users to generate a visual snapshot of their learning.
- Snapshots include the date, entry, and the app's name, with a glowing effect to promote the app.
- Users can either download or copy the generated snapshot.

4. **Dark Mode**:
- The application includes a dark mode toggle (🌙/☀️). Both the main interface and snapshots adapt to light and dark modes.

5. **Responsive Design**:
- The layout adapts seamlessly to different screen sizes, ensuring a smooth experience across desktop, tablet, and mobile devices.

6. **Storage**:
- Entries are saved using `localStorage` so users can retrieve their previous learnings even after refreshing or closing the page.

---

## Installation

### Prerequisites
To run this application, you need the following:
- A modern web browser (Google Chrome, Mozilla Firefox, Microsoft Edge, etc.)
- Internet connection (if hosting online)

### Steps
1. **Clone the Repository**:
```
git clone https://github.com/your-username/zen-note.git
cd zen-note
```

2. **Open the Application**:
Open the `index.html` file in your browser:
```
open index.html
```

3. **Enjoy the Features**:
Start entering your daily learnings, toggle between light and dark modes, and generate beautiful snapshots of your notes!

---

## Contributing

### How to Contribute

We welcome contributions from the community. Here's how you can get involved:

1. **Fork the Repository**:
Fork the repository to your own GitHub account by clicking the "Fork" button.

2. **Create a Branch**:
Once you've forked the repo, create a new branch:
```
git checkout -b new-feature
```

3. **Make Your Changes**:
Make sure your code adheres to our styling guide (follow the existing conventions in HTML, CSS, and JavaScript).

4. **Push Your Changes**:
Push the changes to your branch:
```
git push origin new-feature
```

5. **Create a Pull Request**:
Go to your fork on GitHub and create a pull request. Please provide details on the changes you've made.

### Things to Improve
- **Enhance UX**: Add more customization options for entries.
- **Add Analytics**: Track user engagement and most-used features.
- **Performance Optimization**: Optimize the snapshot generation for mobile.

---



## License

This project is licensed under the MIT License. See the LICENSE file for more details.

---

### Contact

For any questions, suggestions, or feedback, feel free to contact:
- **Email**: [email protected]
- **GitHub**: https://github.com/TheOpenInnovator

---



0 comments on commit 57f4d17

Please sign in to comment.