diff --git a/.tool-versions b/.tool-versions index ab4f062..510eaf4 100644 --- a/.tool-versions +++ b/.tool-versions @@ -1,2 +1,2 @@ -elixir 1.14.3 -erlang 25.2 +elixir 1.15.7-otp-26 +erlang 26.1.2 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 51723e0..70daedd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# Contributing to Uinta +# Contributing to Graphql Markdown Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved! @@ -118,13 +118,13 @@ in order to craft an excellent pull request: ```bash # Clone your fork of the repo into the current directory - git clone https://github.com//uinta + git clone https://github.com//graphql_markdown # Navigate to the newly cloned directory cd uinta # Assign the original repo to a remote called "upstream" - git remote add upstream https://github.com/podium/uinta + git remote add upstream https://github.com/podium/graphql_markdown ``` 2. If you cloned a while ago, get the latest changes from upstream, and update your fork: diff --git a/README.md b/README.md index 494bcff..55c898b 100644 --- a/README.md +++ b/README.md @@ -17,10 +17,15 @@ end And run: - $ mix deps.get +```shell +mix deps.get +``` - # will create a single file called graphql_schema.md in the current dir - $ mix graphql_gen_markdown -f ./schema.json +Generate a single file called `graphql_schema.md` in the current dir: + +```shell +mix graphql_gen_markdown -f ./schema.json +``` Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc) @@ -96,7 +101,7 @@ defmodule Azeroth.MixProject do Make sure the absinthe schema is specified or generated with that name. Or add to your config.exs: -``` +```elixir config :absinthe, schema: YouApp.GraphQL.Schema ``` @@ -118,4 +123,4 @@ Emmanuel Pinault (@epinault) ## License -GraphqlMarkdown is released under the MIT License. See the LICENSE file for further details. \ No newline at end of file +GraphqlMarkdown is released under the MIT License. See the [LICENSE.md](LICENSE.md) file for further details. diff --git a/mix.exs b/mix.exs index 6f6e687..99475bc 100644 --- a/mix.exs +++ b/mix.exs @@ -39,8 +39,11 @@ defmodule GraphqlMarkdown.MixProject do [ main: "readme", extras: [ + "CHANGELOG.md", {:"README.md", title: "Readme"}, - "CHANGELOG.md" + {:"LICENSE.md", title: "License"}, + {:"CONTRIBUTING.md", title: "Contributing"}, + "CODE_OF_CONDUCT.md" ], source_url: @project_url, source_ref: "v#{@version}",