Skip to content

Commit

Permalink
clean-up
Browse files Browse the repository at this point in the history
  • Loading branch information
Fabian Tollenaar committed Jul 30, 2015
1 parent 344e6cc commit 4c9d5d6
Show file tree
Hide file tree
Showing 36 changed files with 20 additions and 18 deletions.
36 changes: 19 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,22 @@ This repository contains the (working) specification for Signal K, defined in
JSON Schema files.


Signal K
--------

The Free and Open Source universal marine data exchange

SignalK is about publishing a common modern and open data format for marine
use. A format for the modern boat, compatible with NMEA, friendly to WiFi,
cellphones, tablets, and the Internet. A format available to everyone, where
anyone can contribute.

To get started, see the summary page and have a look through Navgauge Issue #4
to get a feel for where we started. Then join the mailinglist by sending an
email to [email protected] or follow the discussion via the
Signal K Google Groups forum.


Usage
-----

Expand Down Expand Up @@ -32,8 +48,10 @@ You can browse the Schema using the supplied docson viewer. Just open
index.html from a local webserver (otherwise the XHR requests won't work) in
your preferred browser to get started.


Validation
----------

Validation against SignalK schema can be done
- with a command line validator accepting JSON from stdin
- by explicitly calling validate packaged as an npm module
Expand All @@ -57,20 +75,4 @@ var result = validate(msg);
```
chai.use(require('signalk-schema).chaiModule);
tree.should.be.validSignalK;
```


Signal K
--------

The Free and Open Source universal marine data exchange

SignalK is about publishing a common modern and open data format for marine
use. A format for the modern boat, compatible with NMEA, friendly to WiFi,
cellphones, tablets, and the Internet. A format available to everyone, where
anyone can contribute.

To get started, see the summary page and have a look through Navgauge Issue #4
to get a feel for where we started. Then join the mailinglist by sending an
email to [email protected] or follow the discussion via the
Signal K Google Groups forum.
```
2 changes: 1 addition & 1 deletion ROADMAP.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,5 @@ Please treat this the same as the specification itself: when making changes, mak
- [ ] Add metadata to all groups (min, max, unit, descriptions, etc)
- [ ] Review all open PRs and branches, merge where required and remove when not
- [ ] Check for FIXMEs
- [ ] Clean-up the repo (`master` branch contains stable spec, `development` branch for active development and topic branches for new features)
- [x] Clean-up the repo
- [ ] Update documentation and publish blog posts and news on our first stable release.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 4c9d5d6

Please sign in to comment.