Skip to content

Commit

Permalink
doc: README.rst
Browse files Browse the repository at this point in the history
Update the README.rst file

Signed-off-by: Akarshan Kapoor <data.akarshan@icloud.com>
  • Loading branch information
Kappuccino111 committed May 28, 2024
1 parent 22a64aa commit 2431603
Showing 1 changed file with 9 additions and 22 deletions.
31 changes: 9 additions & 22 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,30 +1,17 @@
LwM2M Server
============
.. image:: doc/source/_static/LogoForReadme.png

Flow Nexus Overview 🌐
======================

This repository hosts a framework to build IoT applications using the LwM2M
protocol. The framework is based on a Leshan LwM2M server and a Django Backend.
This combination allows to manage low power IoT devices, e.g. running Zephyr OS
efficiently.

The project is described in more detail in the linked GitHub pages. The
framework is work in progress and is not yet ready for production use.

External Dependencies
#####################

External components are maintained in their respective versions via a `west`
manifest file. Make sure to configure west to reference the manifest file
(west.yml) in this repository and update all references with::

# Initialize this repository and external components in a new workspace
$ pip3 install west
$ west init -m https://github.com/jonas-rem/lwm2m_server --mr main my_workspace
$ cd my-workspace
$ west update
Getting Started 🛠️
==================

Testing the Framework locally
#############################
Explore our `documentation <https://jonas-rem.github.io/lwm2m_server/>`_ to learn
more about the project and get started!

The framework can be started locally using docker-compose. By using simulated
Zephyr device running in the same local environment, it can be easily tested.
Please check the documentation for more details.
**⚠️ Warning: The framework is a work in progress and is not yet ready for production use.**

0 comments on commit 2431603

Please sign in to comment.