Skip to content

Commit

Permalink
hoo readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Maksasj committed Sep 21, 2024
1 parent c03163d commit 80a4242
Showing 1 changed file with 32 additions and 5 deletions.
37 changes: 32 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,49 @@
# hoo 🐦‍🔥
ASP.NET Core based universal file provider microservice

> **Hoo** is not a new javascript framework btw, this time it is a .NET one
ASP.NET Core based universal file provider microservice, allows to interface with different file services such as **GoogleDrive**, **OneDrive** and others via single convenient interface. With **hoo**, you can seamlessly manage files from multiple platforms using a single API, reducing the complexity of integrating different file providers in your applications

> **hoo** is not a new javascript framework btw, this time it is a .NET one
Cool looking widgets
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/Maksasj/hoo/test.yml?logo=github&label=build)
![GitHub License](https://img.shields.io/github/license/Maksasj/hoo)
![Unit Test Coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/Maksasj/88c718518ac856fce876e5738695db50/raw/hoo-code-coverage.json)
![GitHub Repo stars](https://img.shields.io/github/stars/Maksasj/hoo?style=flat)

### Links

1. Source code available at [github.com/Maksasj/hoo](https://github.com/Maksasj/hoo)
2. **🍡 mochi** logging microservice [github.com/Maksasj/mochi](https://github.com/Maksasj/bebmochione)

## Features
*Todo*

Main features of hoo microservice
- **Multi-provider support**: Interact with multiple file storage providers through a single service.
- **Extendable architecture**: Easily add support for new file providers.
- **RESTful API**: Clean, easy-to-use API for interfacing with file services.
- **Supported providers**: GoogleDrive, OneDrive, HTTP files(also called **WebFiles** (any file that could be accessed via URL))
- **Universall thumbnail provider**

### Planned providers

- **Pinterest** images, boards as WebFiles
- **Youtube** videos as WebFiles

## Developing

Please make sure you have the following prerequisites:
- A desktop platform with the [.NET 8.0 SDK](https://dotnet.microsoft.com/download) installed
- Version control tool [Git](https://git-scm.com/)

## Contribution
*Todo*

When it comes to contributing to the project, the two main things you can do to help out are reporting issues and submitting pull requests.

If you have any questions, feel free to to submit [issue](https://github.com/Maksasj/hoo/issues) or message [author](https://github.com/Maksasj) on social medias.

## License
**Hoo** is free and open source universal file provider microservice. All code in this repository is licensed under

**hoo** is free and open source universal file provider microservice. All code in this repository is licensed under
- Apache-2.0 license ([LICENSE.md](https://github.com/Maksasj/hoo/blob/master/LICENSE.md) or http://www.apache.org/licenses/LICENSE-2.0)

*Copyright 2024 © Maksim Jaroslavcevas*

0 comments on commit 80a4242

Please sign in to comment.