Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
chinxcode authored May 15, 2024
1 parent 18cabb9 commit b114032
Showing 1 changed file with 24 additions and 26 deletions.
50 changes: 24 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,50 +1,48 @@
Sure! Here's a sample README.md file based on the functionality of your code:

---

# AnimeFlix

AnimeFlix is a simple web application that allows users to browse and discover top anime and manga titles. It leverages the Jikan API to fetch data about top anime, top manga, and search results based on user input.
AnimeFlix is a website where you can explore information about anime and manga, watch trailers, and discover streaming platforms to enjoy your favorite shows.

## Features

- **Top Anime**: Display top anime titles fetched from the Jikan API.
- **Top Manga**: Display top manga titles fetched from the Jikan API.
- **Search**: Allow users to search for anime titles and display the search results.
- **Responsive Design**: The application is designed to work seamlessly across various screen sizes, providing a consistent user experience.
- Browse top anime and manga.
- Search for specific titles.
- View detailed information about each anime, including synopsis, ratings, producers, studios, genres, and more.
- Watch trailers and find streaming platforms.
- Responsive design for seamless viewing on various devices.

## Technologies Used

- **HTML**: Structure of the web pages.
- **CSS**: Styling the user interface.
- **JavaScript**: Interactivity and API communication.
- **Jikan API**: Fetching anime and manga data.
- HTML
- CSS
- JavaScript
- Fetch API for data retrieval
- Jikan API for anime and manga information

## Usage or Cloning

## Usage
To run the website locally, follow these steps:

1. Clone this repository.
```bash
1. Clone the repository:
```bash
git clone https://github.com/chinxcode/animeflix.git
```
2. Navigate to the project directory:

2. Navigate to the project directory:
```bash
cd animeflix
```
3. Open `index.html` in your web browser.

3. Open the `index.html` file in your web browser or serve it using a local server.

## Screenshots

![Screenshot](public/screenshot1.png)
![Screenshot 1](public/screenshot1.png)
![Screenshot 2](public/screenshot2.png)

## Contributing
## Contributions

Contributions are welcome! Please feel free to submit pull requests.
Contributions are welcome! If you find any issues or have suggestions for improvements, feel free to open an issue or create a pull request.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

---

Feel free to customize it further to better fit your project or add any additional sections you find relevant!
This project is licensed under the [MIT License](LICENSE).

0 comments on commit b114032

Please sign in to comment.