first commit

README.md

@@ -0,0 +1,42 @@
+# WOD API - Words Of Domain API
+
+WOD API is a quick and simple API to get words of a domain name.
+
+## Key features
+
+* Purely Python
+* It's an API with only 1 endpoint
+* Needs flask library
+* Needs wordsegment library
+
+## Requirements
+
+WOD API requires **flask** and **wordsegment** Python libraries:
+
+* pip install flask
+* pip install wordsegment
+
+## Usage
+
+- Run: python .\wodapi.py
+- Then, a server is deploy on http://127.0.0.1:5000
+- Use GET in endpoing domain: http://127.0.0.1:5000/domain/hereyourdomainname
+
+## Documentation
+
+This is the README file
+
+## Authors
+
+ * Bichi - José Mª Ávila
+ * Antonio Villamarin
+
+## License
+
+This is a NIDOMA development
+
+## Links
+
+- https://grantjenks.com/docs/wordsegment/
+- https://pypi.org/project/wordsegment/
+- https://blog.stoplight.io/python-rest-api