added README.md file, added MIT license file

wyfir · Jul 18, 2024 · e89c3b7 · e89c3b7
1 parent e925700
commit e89c3b7
Show file tree

Hide file tree

Showing 2 changed files with 69 additions and 0 deletions.
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 wyfir 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,48 @@
+# Responsive Slider
+
+Responsive Slider This is a responsive image slider with navigation arrows and dot indicators. The slider is built using HTML, CSS, and JavaScript.
+
+## Features
+
+- Responsive design that works on different screen sizes.
+- Navigation arrows for moving between slides.
+- Dot indicators for direct navigation to specific slides.
+- Fade-in animation for slides.
+- Auto-sliding with a timer.
+
+## Demo
+
+[Live Demonstration](https://wyfir.github.io/Classic-Slider/)
+
+## Installation
+
+1. **Clone the repository:**
+   ```bash
+   git clone https://github.com/wyfir/Classic-Slider.git
+   ```
+2. **Navigate to the project directory:**
+   ```bash
+   cd Classic-Slider
+   ```
+
+## Usage
+
+Include the necessary files in your project and set up the HTML structure as demonstrated in the provided example files.
+
+# Css and JavaScript
+
+Include the styles and script files in your project. Customize the CSS variables to fit your design requirements.
+
+## Important!
+
+Ensure you include the Boxicons CSS in your `<head>`:
+
+```html
+<link
+  rel="stylesheet"
+  href="https://cdn.jsdelivr.net/npm/boxicons@latest/css/boxicons.min.css"
+/>
+```
+# Contributing
+
+Contributions are welcome! Feel free to open issues or submit pull requests to improve this project.