Update README.md

This commit is contained in:
Emil Gulamov 2024-03-17 04:30:38 +00:00 committed by GitHub
parent 991ec9a909
commit 8e3bd5b87c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -9,6 +9,7 @@ ScrewFast is an open-source template designed for quick and efficient web projec
## Table of Contents
* [Why Choose ScrewFast?](#why-choose-screwfast)
* [Features](#features)
* [What's New](#whats-new)
* [Getting Started](#getting-started)
+ [Installation](#installation)
+ [Development Commands](#development-commands)
@ -61,6 +62,33 @@ ScrewFast is an open-source template designed for quick and efficient web projec
- **Markdown Content Collections:** Organize and manage your content seamlessly.
- **SEO and Responsiveness:** Ensure your site is discoverable and accessible on any device.
## What's New
### Added Features
- [x] **Social Share Component**:
- Enables users to share blog posts on social media platforms.
- Provides easy sharing of a blog post's title and URL.
- Integrates Clipboard.js for link URL copy functionality.
- [x] **Bookmark Button Component**:
- Allows users to bookmark blog posts for later reference.
- Provides a visual indication of whether a post is bookmarked.
- Utilizes `localStorage` to store bookmarks locally in the browser.
- For server-side rendering (SSR) or dynamic pages, replace `localStorage` with cookies to persist bookmarked posts.
- This change allows bookmarked posts to be rendered dynamically based on the user's bookmarks.
- [x] **Post Feedback Component**:
- Collects user feedback at the end of each blog post.
- Serves as a UI demonstration with no live back-end integration.
### Planned Improvements
- [ ] Add support for internationalization (i18n).
- [ ] Implement a table of contents (ToC) sidebar for blog articles.
- [ ] Integrate the Starlight documentation theme.
### Bug Fixes
- Currently, there are no known bugs. If you encounter any issues, please report them on our [issues page](https://github.com/mearashadowfax/ScrewFast/issues).
## Getting Started
This guide will provide you with the necessary steps to set up and familiarize yourself with the Astro project on your local development machine.