From 91a5a3f486cb1bb26203ba12b8febb92be8ce033 Mon Sep 17 00:00:00 2001 From: James Harton Date: Sun, 8 Apr 2018 17:11:26 +1200 Subject: [PATCH] Update readme. --- .gitignore | 27 +++++++++++++++++++++++++++ README.md | 25 +++++-------------------- 2 files changed, 32 insertions(+), 20 deletions(-) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..d5be28f --- /dev/null +++ b/.gitignore @@ -0,0 +1,27 @@ +# App artifacts +/_build +/db +/deps +/*.ez + +# Generated on crash by the VM +erl_crash.dump + +# Generated on crash by NPM +npm-debug.log + +# Static artifacts +/assets/node_modules + +# Since we are building assets from assets/, +# we ignore priv/static. You may want to comment +# this depending on your deployment strategy. +/priv/static/ + +# Files matching config/*.secret.exs pattern contain sensitive +# data and you should not commit them into version control. +# +# Alternatively, you may comment the line below and commit the +# secrets files as long as you replace their contents by environment +# variables. +/config/*.secret.exs \ No newline at end of file diff --git a/README.md b/README.md index e6fb37f..d0c2b3a 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,13 @@ # What the heck is GraphQL anyway? -According to [graphql.org](https://graphql.org/) GraphQL is "A query language -for your API" which is really only part of it. +According to [graphql.org](https://graphql.org/) GraphQL is "A query language for your API" which is really only part of it. [Demo time](https://www.graphqlhub.com/playground?query={%0A%20%20graphQLHub%0A%20%20giphy%20{%0A%09%09random(tag%3A%22graphql%22)%20{%0A%20%20%20%20%09id%0A%20%20%20%20%20%20url%0A%20%20%20%20%20%20images%20{%0A%20%20%20%20%20%20%20%20original%20{%0A%20%20%20%20%20%20%20%20%20%20url%0A%20%20%20%20%20%20%20%20}%0A%20%20%20%20%20%20}%0A%20%20%09}%0A%20%20}%0A}) -GraphQL is a specification for the GraphQL query language and how servers and -clients should interact to implement those queries. The [GraphQL -specification](https://github.com/facebook/graphql) is maintained by Facebook -and should probably be treated with care (anyone who has had to maintain a -react-native app knows what I'm talking about). Facebook's philosophy of "move -fast and break things" is great for products but is not great for software -dependencies. +GraphQL is a specification for the GraphQL query language and how servers and clients should interact to implement those queries. The [GraphQL specification](https://github.com/facebook/graphql) is maintained by Facebook and should probably be treated with care (anyone who has had to maintain a react-native app knows what I'm talking about). Facebook's philosophy of "move fast and break things" is great for products but is not great for software dependencies. -Still, there are plenty of open source implementations of the spec now and you -don't need to rely on Facebook's implementations of the server or client. At -this time my gut feeling is still "avoid react/relay" but I know plenty of -people who have and are building successful apps with them. +Still, there are plenty of open source implementations of the spec now and you don't need to rely on Facebook's implementations of the server or client. At this time my gut feeling is still "avoid react/relay" but I know plenty of people who have and are building successful apps with them. -Notable efforts include [Apollo](https://www.apollographql.com/), developed by -the [Meteor team](https://www.meteor.com/) it includes a JavaScript server, -browser client and a bunch of other stuff (like bindings for various JavaScript -frameworks). We'll be using the Apollo client in our demonstrations today. +Notable efforts include [Apollo](https://www.apollographql.com/), developed by the [Meteor team](https://www.meteor.com/) it includes a JavaScript server, browser client and a bunch of other stuff (like bindings for various JavaScript frameworks). We'll be using the Apollo client in our demonstrations today. -Still, this is an Elixir talk so you're probably most interested in hearing -about [Absinthe](https://absinthe-graphql.org/). Check out the `step-2` branch -to learn about it. +Still, this is an Elixir talk so you're probably most interested in hearing about [Absinthe](https://absinthe-graphql.org/). Check out the `step-2` branch to learn about it.