-
Notifications
You must be signed in to change notification settings - Fork 681
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improve README & fix build badge (#757)
- Loading branch information
1 parent
4a7086e
commit 5a8502c
Showing
2 changed files
with
43 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,39 +1,48 @@ | ||
| # BaGet :baguette_bread: | ||
|
|
||
|  [](https://discord.gg/MWbhpf66mk) [](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. | ||
|
|
||
| <p align="center"> | ||
| <img width="100%" src="https://user-images.githubusercontent.com/737941/50140219-d8409700-0258-11e9-94c9-dad24d2b48bb.png"> | ||
| </p> | ||
|
|
||
| ## 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 |