diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..f12e5d009 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,15 @@ +## Contribute + +Please read the [code of conduct] before contributing. + +If you want to run from BaGet's source code: + +1. Install the [.NET SDK] and [Node.js] +2. Run `git clone https://github.com/loic-sharma/BaGet.git` +3. Navigate to `./BaGet/src/BaGet` +4. Start the service with `dotnet run` +5. Open the URL `http://localhost:5000/v3/index.json` in your browser + +[Code of conduct]: CODE_OF_CONDUCT.md +[.NET SDK]: https://www.microsoft.com/net/download +[Node.js]: https://nodejs.org/ \ No newline at end of file diff --git a/readme.md b/readme.md index a3d5c0016..c7c22dfe6 100644 --- a/readme.md +++ b/readme.md @@ -1,8 +1,8 @@ # BaGet :baguette_bread: -![Build status](https://img.shields.io/github/workflow/status/loic-sharma/BaGet/Build/main) [![Discord](https://img.shields.io/discord/889377258068930591)](https://discord.gg/MWbhpf66mk) [![Twitter](https://img.shields.io/twitter/follow/bagetapp?label=Follow)](https://twitter.com/bagetapp) +![Build status] [![Discord][Discord image]][Discord link] [![Twitter][Twitter image]][Twitter link] -A lightweight [NuGet](https://docs.microsoft.com/en-us/nuget/what-is-nuget) and [Symbol](https://docs.microsoft.com/en-us/windows/desktop/debug/symbol-servers-and-symbol-stores) server. +A lightweight [NuGet] and [symbol] server.

@@ -10,30 +10,39 @@ A lightweight [NuGet](https://docs.microsoft.com/en-us/nuget/what-is-nuget) and ## Getting Started -1. Install [.NET Core SDK](https://www.microsoft.com/net/download) -2. Download and extract [BaGet's latest release](https://github.com/loic-sharma/BaGet/releases) +1. Install the [.NET SDK] +2. Download and extract [BaGet's latest release] 3. Start the service with `dotnet BaGet.dll` 4. Browse `http://localhost:5000/` in your browser -For more information, please refer to [our documentation](https://loic-sharma.github.io/BaGet/). +For more information, please refer to the [documentation]. ## Features -* Cross-platform -* [Dockerized](https://loic-sharma.github.io/BaGet/#running-baget-on-docker) -* [Cloud ready](https://loic-sharma.github.io/BaGet/cloud/azure/) -* [Supports read-through caching](https://loic-sharma.github.io/BaGet/configuration/#enabling-read-through-caching) -* Can index the entirety of nuget.org. See [this documentation](https://loic-sharma.github.io/BaGet/import/nugetorg/#mirroring) -* Coming soon: Supports [private feeds](https://loic-sharma.github.io/BaGet/private-feeds/) -* And more! +* **Cross-platform**: runs on Windows, macOS, and Linux! +* **Cloud native**: supports [Docker], [Azure], [AWS], [Google Cloud], [Alibaba Cloud] +* **Offline support**: [mirror a NuGet server] to speed up builds and enable offline downloads Stay tuned, more features are planned! -## Develop +[Build status]: https://img.shields.io/github/actions/workflow/status/loic-sharma/BaGet/.github/workflows/main.yml +[Discord image]: https://img.shields.io/discord/889377258068930591 +[Discord link]: https://discord.gg/MWbhpf66mk +[Twitter image]: https://img.shields.io/twitter/follow/bagetapp?label=Follow +[Twitter link]: https://twitter.com/bagetapp -1. Install [.NET Core SDK](https://www.microsoft.com/net/download) and [Node.js](https://nodejs.org/) -2. Run `git clone https://github.com/loic-sharma/BaGet.git` -3. Navigate to `.\BaGet\src\BaGet` -4. Navigate to `..\BaGet` -5. Start the service with `dotnet run` -6. Open the URL `http://localhost:5000/v3/index.json` in your browser +[NuGet]: https://learn.microsoft.com/nuget/what-is-nuget +[symbol]: https://docs.microsoft.com/en-us/windows/desktop/debug/symbol-servers-and-symbol-stores +[.NET SDK]: https://www.microsoft.com/net/download +[Node.js]: https://nodejs.org/ + +[BaGet's latest release]: https://github.com/loic-sharma/BaGet/releases + +[Documentation]: https://loic-sharma.github.io/BaGet/ +[Docker]: https://loic-sharma.github.io/BaGet/installation/docker/ +[Azure]: https://loic-sharma.github.io/BaGet/installation/azure/ +[AWS]: https://loic-sharma.github.io/BaGet/installation/aws/ +[Google Cloud]: https://loic-sharma.github.io/BaGet/installation/gcp/ +[Alibaba Cloud]: https://loic-sharma.github.io/BaGet/installation/aliyun/ + +[Mirror a NuGet server]: https://loic-sharma.github.io/BaGet/configuration/#enable-read-through-caching \ No newline at end of file