Add README.md

[Copilot]

Adds documentation for the Flask-based document classification API server.

Coverage

• API: Both classification endpoints (/gen_category, /conf_category) with JSON request/response examples and cURL snippets
• Setup: Dependency installation and pickle file requirements (TF-IDF vectorizers, models, ID mappings)
• Architecture: Base Classifier class with GeneralClassifier and ConfidentialClassifier subclasses
• Model Updates: Workflow for retraining and replacing pickled models via Jupyter notebook
• Testing: Unit test execution with example assertions

Example API usage:

curl -X POST http://localhost:5000/gen_category \
  -H "Content-Type: application/json" \
  -d '[{"path": "doc.txt", "text": "Sri Lanka cricket team won the 1996 world championship"}]'
# Response: [{"path": "doc.txt", "category": "sport"}]

Original prompt

Write a readme file for this repository

---

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

[Copilot]

Pull request overview

This PR adds a comprehensive README for the Flask-based document classification API server, documenting its endpoints, setup, architecture, model workflow, and testing.

Changes:

• Introduces high-level overview and feature list for the classifier server.
• Documents installation, required pickle assets, API endpoints (/gen_category, /conf_category), and example requests/responses.
• Describes the classifier architecture, retraining workflow via Jupyter notebook, and how to run the existing unit tests.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

The repository name in the installation instructions is inconsistent with the project title: here it uses Classifer-Server while the header uses Classifier-Server. To avoid confusing users or causing git clone / cd commands to fail when copied, please standardize the spelling of the repository name across the README (likely to Classifier-Server).

Suggested change

	git clone https://github.com/AyeshW/Classifer-Server.git
	cd Classifer-Server
	git clone https://github.com/AyeshW/Classifier-Server.git
	cd Classifier-Server

[Copilot]

The project structure block uses Classifer-Server/ for the root directory, which is inconsistent with the Classifier-Server project name used in the README header. Please align this directory name with the chosen canonical project name to prevent confusion when users mirror the suggested layout.

Suggested change

	Classifer-Server/
	Classifier-Server/