docs

sindresorhus · Mar 3, 2020 · b78410d · b78410d
1 parent 8149a5e
commit b78410d
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 9 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -29,7 +29,7 @@ declare namespace cpy {
 
 		/**
 		File extension.
-		@example `.bar`
+		@example `bar`
 		*/
 		readonly extension: string,
 	}

diff --git a/readme.md b/readme.md
@@ -127,27 +127,38 @@ const cpy = require('cpy');
 
 ###### path
 
-Type: `string`
+Type: `string`\
+Example: `/tmp/dir/foo.bar`
+
+Resolved path to file.
+
+###### relativePath
+
+Type: `string`\
+Example: `dir/foo.bar` if `cwd` was `/tmp`
 
-Resolved path to file. Example: `/tmp/foo.bar`.
+Relative path to file from `cwd`.
 
 ###### name
 
-Type: `string`
+Type: `string`\
+Example: `foo.bar`
 
-Filename. Example: `foo.bar`.
+Filename.
 
 ###### nameWithoutExtension
 
-Type: `string`
+Type: `string`\
+Example: `foo`.
 
-File name without extension. Example: `foo`.
+File name without extension.
 
 ###### extension
 
-Type: `string`
+Type: `string`\
+Example: `bar`.
 
-File extension. Example: `.bar`.
+File extension.
 
 
 ## Progress reporting