diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..da34134 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,76 @@ +# SimpleNotes Landing Page + +This directory contains the landing page for the SimpleNotes app, designed to be deployed via GitHub Pages. + +## Contents + +- `index.html` - The main landing page with app information and account deletion instructions +- `favicon.png` - The app icon + +## Features + +The landing page includes: +- **App Overview**: Description of SimpleNotes features and benefits +- **Feature Highlights**: Grid of key features (security, cloud sync, cross-platform, etc.) +- **Account Deletion Section**: Clear instructions for users to delete their accounts from within the app +- **Links**: Direct links to the GitHub repository and issue tracker +- **Responsive Design**: Mobile-friendly layout that works on all screen sizes + +## Deploying to GitHub Pages + +### Option 1: Deploy from this Repository + +1. Go to your repository on GitHub +2. Navigate to **Settings** > **Pages** +3. Under "Source", select **Deploy from a branch** +4. Select the branch (e.g., `main` or your preferred branch) +5. Select the `/docs` folder +6. Click **Save** +7. Your landing page will be available at: `https://davidnwaneri.github.io/simple_notes_app/` + +### Option 2: Deploy from a Separate Repository + +If you prefer to have a dedicated repository for the landing page: + +1. Create a new repository (e.g., `simple_notes_landing` or `simple_notes_app.github.io`) +2. Copy the contents of this `docs/` folder to the root of the new repository +3. Go to the new repository's **Settings** > **Pages** +4. Select **Deploy from a branch** and choose `main` branch with `/ (root)` folder +5. Your landing page will be available at: `https://davidnwaneri.github.io//` + +## Local Testing + +To test the landing page locally: + +1. Open `index.html` in your web browser, or +2. Use a simple HTTP server: + ```bash + # Python 3 + python3 -m http.server 8000 + + # Python 2 + python -m SimpleHTTPServer 8000 + + # Node.js (with http-server installed) + npx http-server + ``` +3. Visit `http://localhost:8000` in your browser + +## Customization + +The landing page is a single, self-contained HTML file with inline CSS. You can easily customize: +- Colors and gradients in the ` + + +
+
+

📝 SimpleNotes

+

A beautiful, simple, and secure note-taking app built with Flutter and Appwrite

+
+ +
+
+

Why SimpleNotes?

+
+
+

🔒 Secure & Private

+

Your notes are secured with authentication and stored safely using Appwrite backend services.

+
+
+

☁️ Cloud Sync

+

Access your notes from anywhere. All your notes are synchronized across your devices.

+
+
+

✨ Simple & Clean

+

No clutter, no distractions. Just a clean interface to focus on what matters - your notes.

+
+
+

📱 Cross-Platform

+

Built with Flutter, SimpleNotes works seamlessly on Android, iOS, Web, and Desktop.

+
+
+

🚀 Fast & Lightweight

+

Optimized performance ensures your notes are always ready when you need them.

+
+
+

🎨 Beautiful Design

+

Enjoy a modern, aesthetically pleasing interface with customizable themes.

+
+
+
+ +
+

Features

+
    +
  • ✅ Create, edit, and delete notes
    • +
  • ✅ User authentication and account management
    • +
  • ✅ Real-time synchronization
    • +
  • ✅ Responsive design for all screen sizes
    • +
  • ✅ Open-source and free to use
    • +
+
+ + + +
+

Get Started

+

+ SimpleNotes is an open-source project. You can download the source code, contribute, or report issues on GitHub. +

+
+ View on GitHub +
+
+
+ + +
+ +