sync-safari-reading-list/README.md

Sync Safari Reading List to Pinboard bookmarking service.

# sync-safari-reading-list

[![Build Status][ci-img]][ci]

Sync Safari Reading List to [Pinboard][pinboard] bookmarking service.

## Install

```sh
npm install sync-safari-reading-list --save
```

## Usage

```js
const syncList = require('sync-safari-reading-list');
const token = 'PINBOARD_API_TOKEN';

syncList({
	apiToken: token
})
	.then(( res ) => {
		console.log(res);
		/* [{
			url: 'http://example.com/katie',
			pinboardResponse: {
				result_code: 'done'
			}
		}, …] */
	});
```

## API

### syncList(filePath, opts)

Returns: `Promise`

Sync Safari Reading List to Pinboard. If file path to Safari Reading List is not provided, it uses default argument from [read-safari-reading-list](https://github.com/niksy/read-safari-reading-list#readlistfilepath).

Syncing is done with Pinboard `toread` tag.

#### filePath

Type: `String`

Path to property list.

#### opts

Type: `Object`

##### apiToken

Type: `String`

Pinboard API token.

##### cleanUrls

Type: `Boolean`  
Default: `true`

Perform redirects and cleans URLs from mobile subdomains and UTM query parameters.

##### clearList

Type: `Boolean`  
Default: `false`

Should Safari Reading List be cleaned on successful syncing.

## Related

* [sync-safari-reading-list-cli][sync-safari-reading-list-cli] - CLI for this module

## License

MIT © [Ivan Nikolić](http://ivannikolic.com)

[ci]: https://travis-ci.org/niksy/sync-safari-reading-list
[ci-img]: https://img.shields.io/travis/niksy/sync-safari-reading-list.svg
[pinboard]: https://pinboard.in/
[sync-safari-reading-list-cli]: https://github.com/niksy/sync-safari-reading-list-cli