Skip to content

Commit b217982

Browse files
authored
docs(README): Coverage badge, TODOs, Contributing
1 parent e7a1317 commit b217982

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[![Build Status](https://travis-ci.org/graphql-python/graphene-mongo.svg?branch=master)](https://travis-ci.org/graphql-python/graphene-mongo) [![Coverage Status](https://coveralls.io/repos/github/abawchen/graphene-mongo/badge.svg?branch=master)](https://coveralls.io/github/abawchen/graphene-mongo?branch=master) [![Documentation Status](https://readthedocs.org/projects/graphene-mongo/badge/?version=latest)](http://graphene-mongo.readthedocs.io/en/latest/?badge=latest)
1+
[![Build Status](https://travis-ci.org/graphql-python/graphene-mongo.svg?branch=master)](https://travis-ci.org/graphql-python/graphene-mongo) [![Coverage Status](https://coveralls.io/repos/github/graphql-python/graphene-mongo/badge.svg?branch=master)](https://coveralls.io/github/graphql-python/graphene-mongo?branch=master) [![Documentation Status](https://readthedocs.org/projects/graphene-mongo/badge/?version=latest)](http://graphene-mongo.readthedocs.io/en/latest/?badge=latest)
22

33
# Graphene-Mongo
44

@@ -66,20 +66,25 @@ result = schema.execute(query)
6666
## TODOs
6767

6868
- [ ] Examples
69+
- [x] Flask example
70+
- [ ] Django example
71+
- [ ] Filtering
72+
- [x] Basic filtering of equal comparison
73+
- [ ] Advanced filtering
6974
- [ ] Support List(EmbeddedDocument)
7075
- [ ] Paging
71-
- [ ] Filtering
76+
7277

7378
## Contributing
7479

7580
After cloning this repo, ensure dependencies are installed by running:
7681

7782
```sh
78-
python setup.py install
83+
pip install -r requirements.txt
7984
```
8085

8186
After developing, the full test suite can be evaluated by running:
8287

8388
```sh
84-
python setup.py test # Use --pytest-args="-v -s" for verbose mode
89+
make test
8590
```

0 commit comments

Comments
 (0)