Skip to content

Commit

Permalink
docs(tutorial): dedup create-plugin docs
Browse files Browse the repository at this point in the history
  • Loading branch information
germanferrero committed Sep 6, 2021
1 parent c03d9e4 commit 10e171c
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 12 deletions.
10 changes: 1 addition & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -241,14 +241,6 @@ If you need more context to understand how to translate some key you can checkou
And findout how is that key used in the LimeApp.
Also, do not hesitate to contact developers directly :)

### Creating a new plugin
If you want to create a new plugin for the LimeApp you can use the developer tool `create-plugin` to bootstrap the files structure of a new
plugin along with some minimal code to help you understand how each module relates to each other. Go ahead and run

```
npm install
npm run create-plugin <yourPluginName (camelCased)>
```

### More Information

Expand Down Expand Up @@ -324,4 +316,4 @@ members of the project's.
Adapted from [contributor-covenant.org](http://contributor-covenant.org/version/1/4)

[semantic-release]: https://npmjs.com/package/semantic-release
[convention]: https://github.com/conventional-changelog/conventional-changelog-angular/blob/ed32559941719a130bb0327f886d6a32a8cbc2ba/convention.md
[convention]: https://github.com/conventional-changelog/conventional-changelog-angular/blob/ed32559941719a130bb0327f886d6a32a8cbc2ba/convention.md
7 changes: 4 additions & 3 deletions docs/Tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ You can also learn by doing, following this guide and encouraging you to try mak
<figcaption>Architectural Design of the LimeApp</figcaption>
</figure>

The LimeApp is a web application built on top of the [Preact] framework (https://preactjs.com/) which is very similar to React, yet we chose it because it takes less space (3kB).
The LimeApp is a web application built on top of the [Preact framework](https://preactjs.com/) which is very similar to React, yet we chose it because it takes less space (3kB).
The application bundle, which includes all the application code executable by a web browser, is hosted in `/www/app` and is served by the uHTTPd webserver when visiting the IP address of the router or the domain associated with it, typically: thisnode.info.

uHTTPd has a plugin for [ubus](https://openwrt.org/docs/techref/ubus) that allows us to make ubus calls to the different libremesh services/modules through HTTP POST requests using the JSON RPC (Remote Procedure Call) message protocol.
Expand Down Expand Up @@ -514,10 +514,11 @@ Follow instructions at [CONTRIBUTING.md](CONTRIBUTING.md#contributing-with-trans
### 6.1 Script "create-plugin"
This dev tool helps to bootstrap a directory structure for a new plugin.
You only need to chose a name for it,
and a working basic skeleton will be created after it.
and a working basic skeleton will be created under lime-plugin-<newPluginName>.
Try it with:
```
npm run create-plugin <newPluginName>
npm run create-plugin <newPluginName (camelCased)>
```
## 7 Advanced topics
Expand Down

0 comments on commit 10e171c

Please sign in to comment.