Update README.md

LebJe · Dec 3, 2020 · 979e1ff · 979e1ff
1 parent 7f648d5
commit 979e1ff
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -187,6 +187,12 @@ public struct LFSPointer {
 
 	/// The size of the converted file.
 	public let size: Int
+
+	/// The name of the file.
+	public let filename: String
+
+	/// The full path of the file.
+	public let filePath: String
 	
 	/// String representation of this pointer.
 	public var stringRep: String {
@@ -217,7 +223,7 @@ The search types available are:
 .all
 ```
 
-That function returns an array of `LFSPointers`.
+That function returns an array of `LFSPointer`s.
 
 #### Writing Pointers
 After you generate a pointer, write it to a file using:

diff --git a/Sources/LFSPointersKit/Pointers.swift b/Sources/LFSPointersKit/Pointers.swift
@@ -39,7 +39,7 @@ public struct LFSPointer: Codable, Equatable, Hashable {
 	/// The size of the converted file.
 	public let size: Int
 
-	/// The filename of the file.
+	/// The name of the file.
 	public let filename: String
 
 	/// The full path of the file.