diff --git a/README.md b/README.md index 2c43d2753b81a0f231370a5d49e850423636346c..c0aeac484f153c148ce4841f9c0a45a70758f6ae 100644 --- a/README.md +++ b/README.md @@ -12,19 +12,19 @@ It aims at enabling people with little development skills to serve their own dat ## Installation -1. Install this module and all its dependencies +### 1- Install this module and all its dependencies ``` pip install djangoldp ``` -2. Create a django project +### 2- Create a django project ``` django-admin startproject myldpserver ``` -3. Create your django model inside a file myldpserver/myldpserver/models.py +### 3- Create your django model inside a file myldpserver/myldpserver/models.py ``` from django.db import models @@ -35,29 +35,30 @@ class Todo(models.Model): ``` - -3. Add a url in your urls.py: +### 4- Add a url in your urls.py: ``` +from django.conf.urls import url +from django.contrib import admin from djangoldp.views import LDPViewSet from .models import Todo urlpatterns = [ - url(r'^todos/', include(LDPViewSet.urls(model=Todo))), + url(r'^todos/', LDPViewSet.urls(model=Todo)), url(r'^admin/', admin.site.urls), ] ``` This creates 2 routes, one for the list, and one with an ID listing the detail of an object. -4. In the settings.py file, add your application name at the beginning of the application list, and add the following lines +### 5- In the settings.py file, add your application name at the beginning of the application list, and add the following lines ``` STATIC_ROOT = os.path.join(os.path.dirname(BASE_DIR), 'static') LDP_RDF_CONTEXT = 'https://cdn.happy-dev.fr/owl/hdcontext.jsonld' ``` -5. You can also register your model for the django administration site +### 6- You can also register your model for the django administration site ``` from django.contrib import admin @@ -66,7 +67,7 @@ from .models import Todo admin.site.register(Todo) ``` -6. You then need to have your WSGI server pointing on myldpserver/myldpserver/wsgi.py +### 7- You then need to have your WSGI server pointing on myldpserver/myldpserver/wsgi.py ## Execution To start the server, `cd` to the root of your Django project and run : @@ -74,6 +75,6 @@ To start the server, `cd` to the root of your Django project and run : python3 manage.py runserver ``` -## License +## Lic ense No licence yet. Please wait...