Skip to content

Commit

Permalink
Meta tweaks
Browse files Browse the repository at this point in the history
Closes #50
  • Loading branch information
sindresorhus committed May 27, 2020
1 parent 6c32f0c commit 8f40a21
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 14 deletions.
1 change: 1 addition & 0 deletions .travis.yml
Expand Up @@ -4,6 +4,7 @@ os:
- windows
language: node_js
node_js:
- '14'
- '12'
- '10'
- '8'
2 changes: 1 addition & 1 deletion index.test-d.ts
Expand Up @@ -74,4 +74,4 @@ expectType<string | undefined>(findUp.sync((): findUp.StopSymbol => findUp.stop,
expectType<Promise<boolean>>(findUp.exists('unicorn.png'));
expectType<boolean>(findUp.sync.exists('unicorn.png'));

expectType<Symbol>(findUp.stop);
expectType<findUp.StopSymbol>(findUp.stop);
2 changes: 1 addition & 1 deletion license
@@ -1,6 +1,6 @@
MIT License

Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

Expand Down
5 changes: 3 additions & 2 deletions package.json
Expand Up @@ -4,10 +4,11 @@
"description": "Find a file or directory by walking up parent directories",
"license": "MIT",
"repository": "sindresorhus/find-up",
"funding": "https://github.com/sponsors/sindresorhus",
"author": {
"name": "Sindre Sorhus",
"email": "sindresorhus@gmail.com",
"url": "sindresorhus.com"
"url": "https://sindresorhus.com"
},
"engines": {
"node": ">=8"
Expand Down Expand Up @@ -47,7 +48,7 @@
"ava": "^2.1.0",
"is-path-inside": "^2.1.0",
"tempy": "^0.3.0",
"tsd": "^0.7.3",
"tsd": "^0.11.0",
"xo": "^0.24.0"
}
}
15 changes: 5 additions & 10 deletions readme.md
@@ -1,15 +1,13 @@
# find-up [![Build Status](https://travis-ci.org/sindresorhus/find-up.svg?branch=master)](https://travis-ci.org/sindresorhus/find-up)
# find-up [![Build Status](https://travis-ci.com/sindresorhus/find-up.svg?branch=master)](https://travis-ci.com/github/sindresorhus/find-up)

> Find a file or directory by walking up parent directories

## Install

```
$ npm install find-up
```


## Usage

```
Expand Down Expand Up @@ -44,7 +42,6 @@ const findUp = require('find-up');
})();
```


## API

### findUp(name, options?)
Expand Down Expand Up @@ -85,22 +82,22 @@ Type: `object`

##### cwd

Type: `string`<br>
Type: `string`\
Default: `process.cwd()`

Directory to start from.

##### type

Type: `string`<br>
Default: `'file'`<br>
Type: `string`\
Default: `'file'`\
Values: `'file'` `'directory'`

The type of paths that can match.

##### allowSymlinks

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

Allow symbolic links to match if they point to the chosen path type.
Expand Down Expand Up @@ -134,15 +131,13 @@ const findUp = require('find-up');
})();
```


## Related

- [find-up-cli](https://github.com/sindresorhus/find-up-cli) - CLI for this module
- [pkg-up](https://github.com/sindresorhus/pkg-up) - Find the closest package.json file
- [pkg-dir](https://github.com/sindresorhus/pkg-dir) - Find the root directory of an npm package
- [resolve-from](https://github.com/sindresorhus/resolve-from) - Resolve the path of a module like `require.resolve()` but from a given path


---

<div align="center">
Expand Down

0 comments on commit 8f40a21

Please sign in to comment.