Skip to content

Commit c8a88ca

Browse files
committed
docs: Modify README
1 parent 99c3c43 commit c8a88ca

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ from mongoengine import Document
2020
from mongoengine.fields import StringField
2121

2222
class User(Document):
23-
2423
meta = {'collection': 'user'}
2524
first_name = StringField(required=True)
2625
last_name = StringField(required=True)
@@ -62,3 +61,22 @@ query = '''
6261
result = schema.execute(query)
6362
```
6463

64+
## TODOs
65+
66+
- [ ] Examples
67+
- [ ] Paging
68+
- [ ] Filtering
69+
70+
## Contributing
71+
72+
After cloning this repo, ensure dependencies are installed by running:
73+
74+
```sh
75+
python setup.py install
76+
```
77+
78+
After developing, the full test suite can be evaluated by running:
79+
80+
```sh
81+
python setup.py test # Use --pytest-args="-v -s" for verbose mode
82+
```

0 commit comments

Comments
 (0)