Skip to content
Snippets Groups Projects
Commit e9cf4ddf authored by Mathieu Loiseau's avatar Mathieu Loiseau
Browse files

README

parent b38252cd
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 4 additions and 6 deletions
README.md
+ 4
− 6
View file @ e9cf4ddf
...@@ -26,7 +26,7 @@ The following commands are extracted from the aforementionned documentation, it ...@@ -26,7 +26,7 @@ The following commands are extracted from the aforementionned documentation, it
```bash ```bash
python3 -m venv wikstraktorenv #create wikstraktorenv environment python3 -m venv wikstraktorenv #create wikstraktorenv environment
. wikstraktorenv/bin/activate #activate environment . wikstraktorenv/bin/activate #activate environment
pip install Flask pip install Flask #install Flask
``` ```
## Use ## Use
...@@ -46,11 +46,9 @@ The server runs by default on port 5000, you can change that in the ```wikstrakt ...@@ -46,11 +46,9 @@ The server runs by default on port 5000, you can change that in the ```wikstrakt
./wikstraktor_server.py ./wikstraktor_server.py
``` ```
Then there is a very simple API : Then there is a very simple API :
```http * ``GET server_url/search/<word>`` : Searches the word in the default wiktionary
GET server_url/search/<word> #Searches the word in the default wiktionary * ``GET server_url/search/<wiktlang>/<wordlang>/<word>`` : Searches the word In wordlang in the wiktlang wiktionary
GET server_url/search/<wiktlang>/<wordlang>/<word> #Searches the word In wordlang in the wiktlang wiktionary Both API calls return a json object.
```
Both API calls return a json object
## Licence ## Licence
TODO but will be open source TODO but will be open source
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment