Skip to content

Commit

Permalink
feat: reworked the structure and general format of the README file.
Browse files Browse the repository at this point in the history
  • Loading branch information
druxorey committed Oct 9, 2024
1 parent b269a6b commit ec6f7cc
Showing 1 changed file with 23 additions and 10 deletions.
33 changes: 23 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,33 @@
# Startpage
<h1 align="center">Startpage</h1>

<p align="center">A minimalist startpage designed for quick access to your favorite websites</p>

![Startpage Screenshot](/resources/startpage-2024-10-08.webp)

This is my personalized startpage, designed to be my browser homepage. It includes quick links to my favorite websites, a search bar, and a minimalist layout.

![Screenshot](resources/startpage-2024-07-24.webp)
## Repository Structure

## Usage
- **resources**: This directory contains screenshots of the page.
- **scripts**: This directory contains the scripts used in the startpage.
- **static**: This directory contains the CSS and other files used in the startpage.

1. Clone this repository: `git clone https://github.com/druxorey/startpage.git`
2. Open `index.html` in your browser.
3. Customize the links and style according to your preferences.
## Contribute

## Customization
If you want to make any change, follow these steps:

You can personalize the startpage by editing the `index.html` file. Change the colors, and styles in the `style.css` to suit your needs.
1. Open an issue to discuss the changes.
2. Fork this repository.
3. Create a new branch for your contribution: `git checkout -b your-branch-name`.
4. Make your changes.
5. Commit your changes, for example: `git commit -m 'fix: incorrect svg path'`.
6. Push your changes to your forked repository: `git push origin your-branch-name`.
7. Open a Pull Request in this repository and reference the original issue.

# Credits
## License

- Inspired from [Fxzii Startpage](https://github.com/Fxzzi/startpage).
This project is licensed under the GPL-3.0 License. See the [LICENSE](LICENSE) file for more details.

## Credits

- Inspired from [Fxzii Startpage](https://github.com/Fxzzi/startpage).

0 comments on commit ec6f7cc

Please sign in to comment.