diff --git a/README.md b/README.md index d673e0b..72e0860 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,38 @@ # Bookboxd letterboxd but for books + +## Features + +- Search for books using the Google Books API +- Create and manage personal book lists +- Explore book lists created by other users +- Like and comment on book lists +- View detailed information about each book + +## Setup + +1. Clone the repository +2. Install dependencies: `pip install -r requirements.txt` +3. Set up your Google Books API key in `settings.py` +4. Run migrations: `python manage.py migrate` +5. Start the server: `python manage.py runserver` + +## Usage + +- Register/Login to create and manage your book lists +- Use the search function to find books and add them to your lists +- Explore other users' lists, like them, and leave comments +- Click on any book to view its detailed information + +## Technologies Used + +- Django +- Python +- SQLite +- HTML/CSS +- JavaScript/jQuery +- Google Books API + +## Contributing + +Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. \ No newline at end of file