diff --git a/README.md b/README.md index 09c6d37..84688af 100644 --- a/README.md +++ b/README.md @@ -1 +1,11 @@ -typescript-graphql-server-template +# Template for Express Graphql servers + +This repository can be used as a template to create a graphql webservice with nodejs and express. + +## Install + +Just clone the repository and run `npm i`. + +## Build + +To build the project and run it, type `gulp` (if gulp was not found, install it with `npm i -g gulp`). To run it you would run `node ./dist` which executes the generated `index.js` file in the dist directory.