From c81ba1161656161512a3eee1410636a2b5f9d159 Mon Sep 17 00:00:00 2001
From: Edward Betts <edward@4angle.com>
Date: Fri, 29 Sep 2023 12:31:15 +0100
Subject: [PATCH] Add README.md and LICENSE

---
 LICENSE   | 21 ++++++++++++++++++
 README.md | 66 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 87 insertions(+)
 create mode 100644 LICENSE
 create mode 100644 README.md

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..379270c
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Edward Betts <edward@4angle.com>
+
+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
new file mode 100644
index 0000000..9941976
--- /dev/null
+++ b/README.md
@@ -0,0 +1,66 @@
+# Flickr Photo Finder for Wikipedia Articles
+
+This tool is designed to help you find photos on Flickr for Wikipedia articles
+and contact the photographer. It's a Python application that leverages the Flask
+framework for web development.
+
+## Table of Contents
+- [Introduction](#introduction)
+- [Usage](#usage)
+- [Error Handling](#error-handling)
+- [Running the Application](#running-the-application)
+
+## Introduction
+
+This tool is developed and maintained by Edward Betts (edward@4angle.com). Its
+primary purpose is to simplify the process of discovering and contacting
+photographers on Flickr whose photos can be used to enhance Wikipedia articles.
+
+### Key Features
+- Search for Flickr photos related to specific Wikipedia articles.
+- Generate messages to request permission to use photos on Wikipedia.
+- Handle exceptions gracefully and provide detailed error information.
+
+## Usage
+
+To use the tool, follow these steps:
+
+1. Start the tool by running the script.
+2. Access the tool through a web browser.
+3. Enter the Wikipedia URL for the article you want to find photos for.
+4. Optionally, provide a Flickr URL if you already have one in mind.
+5. The tool will extract relevant information and generate a message for you to
+   request permission to use the photo on Wikipedia.
+
+## Error Handling
+
+The application includes error handling to ensure a smooth user experience. If
+an error occurs, it will display a detailed error message with traceback
+information. The error handling is designed to provide valuable insights into
+any issues that may arise during use.
+
+## Running the Application
+
+To run the application, ensure you have Python 3 installed on your system. You
+will also need to install the required Python modules mentioned in the script,
+including Flask, requests, and others.
+
+1. Clone this repository to your local machine.
+2. Navigate to the project directory.
+3. Run the following command to start the application:
+
+```bash
+python3 your_script_name.py
+```
+
+Replace `your_script_name.py` with the actual name of your script.
+
+4. Access the application by opening a web browser and visiting the provided URL
+   (usually `http://localhost:5000/`).
+
+That's it! You can now use the Flickr Photo Finder tool to streamline the process of finding and contacting photographers for Wikipedia articles.
+
+If you encounter any issues or have questions, feel free to contact Edward Betts
+(edward@4angle.com).
+
+Happy photo hunting!