Skip to content

Commit a57834a

Browse files
committed
Add installation instructions
1 parent 7cd7238 commit a57834a

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# GraphQL for Umbraco
2+
[![NuGet release](https://img.shields.io/nuget/v/Our.Umbraco.GraphQL.svg)](https://www.nuget.org/packages/Our.Umbraco.GraphQL)
23

34
## What is this
45
An experimental implementation of [GraphQL](https://graphql.org) for Umbraco using [GraphQL for .NET](https://github.com/graphql-dotnet/graphql-dotnet).
@@ -12,12 +13,22 @@ An Owin middleware exposes Umbraco Published Content as a GraphQL endpoint.
1213

1314
GraphQL types are dynamically generated for all Umbraco document types (content and media), with all the properties as fields. They all implement an interface `PublishedContent` which implements the generic Umbraco properties as fields.
1415

16+
## Installation
1517

18+
The preferred way to install GraphQL for Umbraco is through NuGet
1619

17-
## Getting started
18-
Clone the repository and run the Website (F5 in Visual Studio), install Umbraco with the starter kit and start exploring the API using GraphiQL by opening `/umbraco/graphiql`.
20+
### Option 1: NuGet
21+
22+
GraphQL for Umbraco is available as a NuGet [package](https://www.nuget.org/packages/Our.Umbraco.GraphQL).
23+
24+
To install run the following command in the [Package Manager Console](https://docs.nuget.org/docs/start-here/using-the-package-manager-console)
1925

20-
There's also a [download](https://drive.google.com/file/d/1L67kZV7u6tXy45zknLih421Rlbrx3fh3/view) which contains a prebuilt website with some sample data based on the starter kit. Login `[email protected]`/`1234567890`. It's based on the Umbraco starter kit, where `People`, `Products` and `Blog` has been moved to the root of the tree.
26+
```powershell
27+
PM> Install-Package Our.Umbraco.GraphQL
28+
```
29+
30+
### Option 2: From source
31+
Clone the repository and run the Website (F5 in Visual Studio), install Umbraco with the starter kit and start exploring the API using GraphiQL by opening `/umbraco/graphiql`.
2132

2233
### Urls
2334
| Url | Description |

0 commit comments

Comments
 (0)