SixLabors.ImageSharp.Web

ImageSharp.Web is a new high-performance ASP.NET Core middleware leveraging the ImageSharp graphics library.

License

• ImageSharp.Web is licensed under the Apache License, Version 2.0
• An alternative Commercial License can be purchased for projects and applications requiring support. Please visit https://sixlabors.com/pricing for details.

Documentation

• Detailed documentation for the ImageSharp.Web API is available. This includes additional conceptual documentation to help you get started.

Questions

• Do you have questions? We are happy to help! Please join our Discussions Forum, or ask them on Stack Overflow using the ImageSharp.Web tag. Please do not open issues for questions.
• Please read our Contribution Guide before opening issues or pull requests!

Code of Conduct

This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community. For more information, see the .NET Foundation Code of Conduct.

Installation

Install stable releases via Nuget; development releases are available via MyGet.

Package Name	Release (NuGet)	Nightly (MyGet)
SixLabors.ImageSharp.Web

Manual build

If you prefer, you can compile ImageSharp.Web yourself (please do and help!)

• Using Visual Studio 2019
  • Make sure you have the latest version installed
  • Make sure you have the .NET Core 3.1 SDK installed

Alternatively, you can work from command line and/or with a lightweight editor on both Linux/Unix and Windows:

• Visual Studio Code with C# Extension
• .NET Core

To clone ImageSharp.Web locally, click the "Clone in [YOUR_OS]" button above or run the following git commands:

git clone https://github.com/SixLabors/ImageSharp.Web

If working with Windows please ensure that you have enabled log file paths in git (run as Administrator).

git config --system core.longpaths true

This repository contains git submodules. To add the submodules to the project, navigate to the repository root and type:

git submodule update --init --recursive

Running the Tests

The unit tests require Azurite Azure Storage Emulator in order to run.

On Windows to install and run the server as a background process run the following command

npm install -g azurite
start /B azurite --loose

On Linux

sudo npm install -g azurite
sudo azurite --loose &

How can you help?

Please... Spread the word, contribute algorithms, submit performance improvements, unit tests, no input is too little. Make sure to read our Contribution Guide before opening a PR.

The ImageSharp.Web Team

• James Jackson-South
• Dirk Lemstra
• Anton Firsov
• Scott Williams
• Brian Popow

Sponsor Six Labors

Support the efforts of the development of the Six Labors projects. [Become a sponsor :heart:]

Platinum Sponsors

Become a platinum sponsor with a monthly donation of $2000 (providing 32 hours of maintenance and development) and get 2 hours of dedicated support (remote support available through chat or screen-sharing) per month.

In addition you get your logo (large) on our README on GitHub and the home page (large) of sixlabors.com

Gold Sponsors

Become a gold sponsor with a monthly donation of $1000 (providing 16 hours of maintenance and development) and get 1 hour of dedicated support (remote support available through chat or screen-sharing) per month.

In addition you get your logo (large) on our README on GitHub and the home page (medium) of sixlabors.com

Silver Sponsors

Become a silver sponsor with a monthly donation of $500 (providing 8 hours of maintenance and development) and get your logo (medium) on our README on GitHub and the product pages of sixlabors.com

Bronze Sponsors

Become a bronze sponsor with a monthly donation of $100 and get your logo (small) on our README on GitHub.