Create first correct README

Author: NetroScript

README.md

@@ -1,38 +1,61 @@
-# create-svelte
+# huggingface-llm-filtering
 
-Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte).
+Explore and filter HuggingFace models with ease. This utility web application enables users to view all models from a specific HuggingFace user, offering advanced filtering options tailored for Large Language Models (LLMs).
 
-## Creating a project
+🔗 **Live Version:** [https://netroscript.github.io/huggingface-llm-filtering/](https://netroscript.github.io/huggingface-llm-filtering/)
 
-If you're seeing this, you've probably already done this step. Congrats!
+## Features
 
-```bash
-# create a new project in the current directory
-npm create svelte@latest
+- **Quick Search:** Instantly search for models by their names.
+- **Flexible Filtering:** Filter by model type (GGML, GPTQ, GGUF), model size, and licensing.
+- **Custom Sorting:** Organize models based on time, downloads, or likes.
 
-# create a new project in my-app
-npm create svelte@latest my-app
-```
+![Application Screenshot](https://github.com/NetroScript/huggingface-llm-filtering/assets/18115780/1d8f05de-77c4-4ecb-9e3e-93a8f7c26489)
+
+## Tech Stack
+
+- **Framework:** [SvelteKit](https://kit.svelte.dev/)
+- **UI Toolkit:** [skeleton.dev](https://www.skeleton.dev/)
+- **Data Source:** The app fetches models from a HuggingFace author through the official API and processes the data for optimized display.
+
+## Development
+
+### Setup
+
+Install the necessary dependencies:
+   ```bash
+   pnpm install
+   # Alternatively, you can use npm install or yarn
+   ```
 
-## Developing
+### Running Locally
 
-Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
+To start a development server:
 
 ```bash
-npm run dev
+pnpm run dev
+```
+
+Or to start the server and launch the app in a new browser tab:
 
-# or start the server and open the app in a new browser tab
-npm run dev -- --open
+```bash
+pnpm run dev -- --open
 ```
 
-## Building
+### Building for Production
+
+To generate a production-ready version of the app (exported as static HTML):
+
+```bash
+pnpm run build
+```
 
-To create a production version of your app:
+Preview the production build using:
 
 ```bash
-npm run build
+pnpm run preview
 ```
 
-You can preview the production build with `npm run preview`.
+### Continuous Deployment
 
-> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment.
+This repository is equipped with a GitHub Actions workflow that auto-deploys changes to the GitHub Pages site.