Skip to content

Commit

Permalink
Clarify cookbook example READMEs
Browse files Browse the repository at this point in the history
Currently the relay cookbook's readme has a link to the plain tutorial
page. The plain cookbook readme also instructs the user to change
directory into the directory for the relay example. This change fixes
both issues.

Also changed the title for the relay example to specify that it uses
relay.
  • Loading branch information
axm2 authored and firaskafri committed Nov 15, 2022
1 parent 86c5309 commit a000d58
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion examples/cookbook-plain/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ whole Graphene repository:
```bash
# Get the example project code
git clone https://github.com/graphql-python/graphene-django.git
cd graphene-django/examples/cookbook
cd graphene-django/examples/cookbook-plain
```

It is good idea (but not required) to create a virtual environment
Expand Down
4 changes: 2 additions & 2 deletions examples/cookbook/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Cookbook Example Django Project
Cookbook Example (Relay) Django Project
===============================

This example project demos integration between Graphene and Django.
Expand Down Expand Up @@ -60,5 +60,5 @@ Now you should be ready to start the server:
Now head on over to
[http://127.0.0.1:8000/graphql](http://127.0.0.1:8000/graphql)
and run some queries!
(See the [Graphene-Django Tutorial](http://docs.graphene-python.org/projects/django/en/latest/tutorial-plain/#testing-our-graphql-schema)
(See the [Graphene-Django Tutorial](http://docs.graphene-python.org/projects/django/en/latest/tutorial-relay/#testing-our-graphql-schema)
for some example queries)

0 comments on commit a000d58

Please sign in to comment.