Skip to content

Commit

Permalink
Move to GitHub Actions
Browse files Browse the repository at this point in the history
  • Loading branch information
sindresorhus committed Jan 24, 2021
1 parent 7892c8a commit ab81102
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 14 deletions.
23 changes: 23 additions & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: CI
on:
- push
- pull_request
jobs:
test:
name: Node.js ${{ matrix.node-version }}
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
node-version:
- 14
- 12
- 10
- 8
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node-version }}
- run: npm install
- run: npm test
4 changes: 0 additions & 4 deletions .travis.yml

This file was deleted.

3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@
"description": "Easily load and save config without having to think about where and how",
"license": "BSD-2-Clause",
"repository": "yeoman/configstore",
"funding": "https://github.com/yeoman/configstore?sponsor=1",
"author": {
"name": "Sindre Sorhus",
"email": "sindresorhus@gmail.com",
"url": "sindresorhus.com"
"url": "https://sindresorhus.com"
},
"engines": {
"node": ">=8"
Expand Down
14 changes: 5 additions & 9 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,19 @@
# configstore [![Build Status](https://travis-ci.org/yeoman/configstore.svg?branch=master)](https://travis-ci.org/yeoman/configstore)
# configstore

> Easily load and persist config without having to think about where and how
The config is stored in a JSON file located in `$XDG_CONFIG_HOME` or `~/.config`.<br>
The config is stored in a JSON file located in `$XDG_CONFIG_HOME` or `~/.config`.\
Example: `~/.config/configstore/some-id.json`

*If you need this for Electron, check out [`electron-store`](https://github.com/sindresorhus/electron-store) instead.*<br>
*If you need this for Electron, check out [`electron-store`](https://github.com/sindresorhus/electron-store) instead.*\
*And check out [`conf`](https://github.com/sindresorhus/conf) for an updated approach to this concept.*


## Install

```
$ npm install configstore
```


## Usage

```js
Expand All @@ -42,7 +40,6 @@ console.log(config.get('awesome'));
//=> undefined
```


## API

### Configstore(packageName, defaults?, options?)
Expand All @@ -67,14 +64,14 @@ Type: `object`

##### globalConfigPath

Type: `boolean`<br>
Type: `boolean`\
Default: `false`

Store the config at `$CONFIG/package-name/config.json` instead of the default `$CONFIG/configstore/package-name.json`. This is not recommended as you might end up conflicting with other tools, rendering the "without having to think" idea moot.

##### configPath

Type: `string`<br>
Type: `string`\
Default: Automatic

**Please don't use this option unless absolutely necessary and you know what you're doing.**
Expand Down Expand Up @@ -127,7 +124,6 @@ config.all = {
};
```


---

<div align="center">
Expand Down

0 comments on commit ab81102

Please sign in to comment.