Skip to content

Commit

Permalink
Update README (add a link to supported features)
Browse files Browse the repository at this point in the history
  • Loading branch information
sbernard31 committed Nov 15, 2017
1 parent 3b8e7a9 commit b7e0d80
Showing 1 changed file with 18 additions and 7 deletions.
25 changes: 18 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,15 @@

[Eclipse Leshan™](https://eclipse.org/leshan) is an OMA Lightweight M2M server and client Java implementation.

[What is OMA LWM2M ?](http://technical.openmobilealliance.org/Technical/release_program/lightweightM2M_v1_0.aspx)
[The specification](http://openmobilealliance.org/release/LightweightM2M/V1_0-20170208-A/OMA-TS-LightweightM2M-V1_0-20170208-A.pdf).
[What is OMA LWM2M ?](http://www.openmobilealliance.org/wp/overviews/lightweightm2m_overview.html)
[The specification](http://openmobilealliance.org/release/LightweightM2M/V1_0_1-20170704-A/OMA-TS-LightweightM2M-V1_0_1-20170704-A.pdf).
[Object and Resource Registry](http://www.openmobilealliance.org/wp/OMNA/LwM2M/LwM2MRegistry.html).

Leshan provides libraries which help people to develop their own Lightweight M2M server and client.
The project also provides a client, a server and a bootstrap server demonstration as an example of the Leshan API and for testing purpose.

[Here](https://github.com/eclipse/leshan/wiki/LWM2M-Supported-features) you can see which part of the specification is currently covered by Leshan.

Contact
-------

Expand All @@ -30,7 +32,7 @@ You can try live our servers demos instances:

(Automatic deployment of master branch)

Test Leshan locally
Test Leshan Demos locally
-----------------------
Get and run the last binary of our demo **server** :
```
Expand All @@ -48,8 +50,18 @@ wget https://hudson.eclipse.org/leshan/job/leshan/lastSuccessfulBuild/artifact/l
java -jar ./leshan-bsserver-demo.jar
```

Compile & Run
Compile Leshan & Run Demos
-------------
Get sources :
```bash
#using ssh
git clone git@github.com:eclipse/leshan.git
#using https
git clone https://github.com/eclipse/leshan.git

```

Compile it, by running in leshan root folder :

```
mvn clean install
Expand All @@ -61,14 +73,13 @@ java -jar leshan-server-demo/target/leshan-server-demo-*-SNAPSHOT-jar-with-depen
```

Connect on Leshan demo UI: http://localhost:8080
Leshan provides a very simple UI to get the list of connected clients and interact with clients resources.
Leshan server Demo provides a very simple UI to get the list of connected clients and interact with clients resources.

Now you can register a LWM2M client by running our **client** demo:
```
java -jar leshan-client-demo/target/leshan-client-demo-*-SNAPSHOT-jar-with-dependencies.jar
```
or trying the [Eclipse Wakaama](http://eclipse.org/wakaama) test client or script samples of its lua binding [lualwm2m] (https://github.com/sbernard31/lualwm2m).

or trying the [Eclipse Wakaama](http://eclipse.org/wakaama) test client.

You can also try our **bootstrap** demo server:
```
Expand Down

0 comments on commit b7e0d80

Please sign in to comment.