Skip to content

Commit

Permalink
Merge pull request #10 from JollyJolli/beta
Browse files Browse the repository at this point in the history
feat: Made README.md better
  • Loading branch information
JollyJolli authored Oct 1, 2024
2 parents c9d16d0 + 1929312 commit e6daa73
Showing 1 changed file with 72 additions and 48 deletions.
120 changes: 72 additions & 48 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,48 +1,72 @@
# 🌐 Formen.cc

## Overview

**Formen.cc** is the main website where you can find all my projects and contributions. It serves as a central hub for everything I have worked on, showcasing a diverse range of projects across different domains.

## Features

- **Project Repository**: Access to all my personal projects and contributions.
- **Modern Web Technologies**: The website is built using a combination of modern web technologies to ensure performance and reliability.
- **Analytics**: Google Analytics and GA4 for comprehensive data tracking.
- **Video Player**: Integrated with Ruffle for enhanced video playback.
- **Security**: Implemented HSTS for secure browsing.
- **Typography**: Utilizes Font Awesome 6.1.0 for rich iconography.
- **Caching Tool**: Powered by Varnish for optimized content delivery.
- **CDN**: Distributed content via Cloudflare, cdnjs, and Fastly for faster load times.
- **Tag Management**: Managed through Google Tag Manager.
- **PaaS**: Hosted on GitHub Pages for easy deployment and scalability.

## Installation

No installation is required to view or use the website. Simply visit [Formen.cc](https://formen.cc) in your browser.

## Usage

Explore the site to find various projects. Each project is documented with its purpose, features, and how to get started.

## Contributing

We welcome contributions to enhance Formen.cc. To contribute:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Commit your changes and push them to your branch.
4. Submit a pull request with a detailed description of your changes.

## License

This project does not have a specific license.

## Authors

The website is maintained and developed by Formen.

## Project Status

Formen.cc is currently live and publicly accessible. However, we are constantly looking for improvements and welcome suggestions from the community.

# πŸ“š Formen.cc

## πŸ“– Table of Contents
1. [Overview](#overview)
2. [Features](#features)
3. [Structure](#structure)
- [Head Section](#head-section)
- [Body Section](#body-section)
- [Scripts](#scripts)
4. [Dependencies](#dependencies)
5. [Usage](#usage)
6. [Contributing](#contributing)
7. [License](#license)
8. [Contact](#contact)

## πŸš€ Overview
This HTML document represents the **Formen** website's landing page, showcasing various projects and providing a space to promote important tools and resources. The page is designed to be user-friendly and visually appealing, offering an engaging way for visitors to explore projects and learn more about web development.

## 🌟 Features
- **πŸ“Š Google Analytics**: Integrated to track user interactions and website performance.
- **πŸ“± Responsive Design**: Optimized for viewing on various devices (desktop, tablet, mobile).
- **πŸŽ‰ Promotional Sections**: Dedicated areas for highlighting important projects and resources.
- **πŸ” Project Filtering**: Provides buttons to filter projects by categories.

| Feature | Description |
|----------------------|--------------------------------------------------------|
| Google Analytics | Tracks user interactions. |
| Responsive Design | Adapts to various screen sizes. |
| Promotional Sections | Showcases important projects and resources. |
| Project Filtering | Allows users to sort projects easily. |

## πŸ—οΈ Structure
### 🏠 Head Section
- **Meta Tags**: Includes charset, viewport settings, and SEO keywords.
- **Favicon and Apple Touch Icon**: Custom icons for branding.
- **Stylesheets**: Links to Font Awesome for icons and a custom stylesheet (`styles.css`).
- **Title**: The page title is set to "Formen - Descubre Mis Sitios Web".

### πŸ“œ Body Section
- **Landing Page Section**: Welcoming message and description of the projects.
- **Promotional Sections**: Areas dedicated to showcasing important projects and resources.
- **Projects Header**: Title for the project section and filter buttons.
- **Projects Container**: Placeholder for dynamically inserted project cards.

### πŸ› οΈ Scripts
- **External Scripts**: Includes a script (`script.js`) to handle dynamic functionality and Google Analytics for tracking.

## πŸ”— Dependencies
- **Font Awesome**: For icons, included via a CDN link.
- **Custom CSS**: Ensure you have a `styles.css` file for styling.
- **JavaScript File**: Ensure you have a `script.js` file to implement the project card functionality and filter options.

## 🏁 Usage
1. **Clone the Repository**: Use the following command to clone the repository:
```bash
git clone <repository-url>
```
2. **Open the HTML File**: Open the `index.html` file in a web browser to view the page.
3. **Customize**: Modify the content in the HTML file, CSS styles in `styles.css`, and JavaScript functionality in `script.js` as needed.

## 🀝 Contributing
Feel free to contribute by forking the repository, making your changes, and submitting a pull request. Contributions are welcome, especially for enhancing project descriptions and improving the overall design.

## πŸ“ License
This project is licensed under the MIT License. See the LICENSE file for details.

## πŸ“¬ Contact
For inquiries or suggestions, please contact me by opening a issue.

---

Thank you for visiting the Formen project website! 🌐

0 comments on commit e6daa73

Please sign in to comment.