-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from jason-fox/develop
Add links and badges
- Loading branch information
Showing
1 changed file
with
21 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,64 +1,59 @@ | ||
# JSON Editor widget | ||
|
||
The JSON Editor widget is a WireCloud widget that provides an easy way for you to view, edit, format and validate JSON | ||
structures. | ||
[![](https://nexus.lab.fiware.org/repository/raw/public/badges/chapters/visualization.svg)](https://www.fiware.org/developers/catalogue/) | ||
![](https://img.shields.io/github/license/Wirecloud/json-editor-widget.svg) | ||
|
||
The JSON Editor widget is a [WireCloud widget](http://wirecloud.readthedocs.org/en/latest/) that provides an easy way | ||
for you to view, edit, format and validate JSON structures. | ||
|
||
## Build | ||
|
||
Be sure to have installed [Node.js](http://node.js) and [Bower](http://bower.io) | ||
in your system. For example, you can install it on Ubuntu and Debian running the | ||
following commands: | ||
Be sure to have installed [Node.js](http://node.js) and [Bower](http://bower.io) in your system. For example, you can | ||
install it on Ubuntu and Debian running the following commands: | ||
|
||
```bash | ||
```console | ||
curl -sL https://deb.nodesource.com/setup | sudo bash - | ||
sudo apt-get install nodejs | ||
sudo apt-get install npm | ||
sudo npm install -g bower | ||
``` | ||
|
||
Install other npm dependencies by running: (need root because some libraries use applications, check package.json before to be sure) | ||
Install other npm dependencies by running: (need root because some libraries use applications, check package.json before | ||
to be sure) | ||
|
||
```bash | ||
```console | ||
sudo npm install | ||
``` | ||
|
||
For build the widget you need download grunt: | ||
|
||
```bash | ||
```console | ||
sudo npm install -g grunt-cli | ||
``` | ||
|
||
And now, you can use grunt: | ||
|
||
```bash | ||
```console | ||
grunt | ||
``` | ||
|
||
If everything goes well, you will find a wgt file in the `build` folder. | ||
|
||
|
||
## Documentation | ||
|
||
Documentation about how to use this widget is available on the | ||
[User Guide](src/doc/userguide.md). Anyway, you can find general information | ||
about how to use widgets on the | ||
[WireCloud's User Guide](https://wirecloud.readthedocs.io/en/stable/user_guide/) | ||
available on Read the Docs. | ||
|
||
Documentation about how to use this widget is available on the [User Guide](src/doc/userguide.md). Anyway, you can find | ||
general information about how to use widgets on the | ||
[WireCloud's User Guide](https://wirecloud.readthedocs.io/en/stable/user_guide/) available on Read the Docs. | ||
|
||
## Copyright and License | ||
|
||
Copyright 2016 CoNWeT Lab., Universidad Politecnica de Madrid | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the | ||
License. You may obtain a copy of the License at | ||
|
||
http://www.apache.org/licenses/LICENSE-2.0 | ||
http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an | ||
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific | ||
language governing permissions and limitations under the License. |