resin-config-json v2.0.0

resin-config-json

Join our online chat at

Resin.io config.json manipulation utilities.

Role

The intention of this module is to provide low level utilities to read and write config.json from Resin.io devices.

THIS MODULE IS LOW LEVEL AND IS NOT MEANT TO BE USED BY END USERS DIRECTLY.

Installation

Install resin-config-json by running:

$ npm install --save resin-config-json

Documentation

• config
  • .read(image, type) ⇒ Promise
  • .write(image, type, config) ⇒ Promise

config.read(image, type) ⇒ Promise

Kind: static method of config
Summary: Read a config.json from an image
Access: public
Fulfil: Object - config.json

Example

config.read('/dev/disk2', 'raspberry-pi').then (config) ->
	console.log(config)

config.write(image, type, config) ⇒ Promise

Kind: static method of config
Summary: Write a config.json to an image
Access: public

Example

config.write '/dev/disk2', 'raspberry-pi',
	username: 'foobar'
.then ->
	console.log('Done!')

Support

If you're having any problem, please raise an issue on GitHub and the Resin.io team will be happy to help.

Tests

Run the test suite by doing:

$ gulp test

Contribute

• Issue Tracker: github.com/resin-io/resin-config-json/issues
• Source Code: github.com/resin-io/resin-config-json

Before submitting a PR, please make sure that you include tests, and that coffeelint runs without any warning:

$ gulp lint

License

The project is licensed under the Apache 2.0 license.