update readme

Author: naftaly

.gitignore

@@ -61,3 +61,4 @@ fastlane/Preview.html
 fastlane/screenshots/**/*.png
 fastlane/test_output
 .DS_Store
+.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata

README.md

@@ -1 +1,54 @@
-# MemoryMap
+
+# Welcome to MemoryMap! 🚀
+
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://opensource.org/licenses/MIT)
+[![Swift](https://img.shields.io/badge/Swift-5.5-orange.svg)](https://swift.org/)
+[![Platform](https://img.shields.io/badge/platform-iOS%20%7C%20macOS%20%7C%20tvOS%20%7C%20watchOS%20%7C%20visionOS-lightgrey.svg)]()
+
+MemoryMap is a Swift utility class designed for efficient persistence and crash-resilient storage of Plain Old Data (POD) structs using memory-mapped files. It provides thread-safe access to the stored data, ensuring integrity and performance for applications requiring low-latency storage solutions.
+
+## 🌟 Features
+
+- **Memory-mapped file support**: Back a POD struct with a memory-mapped file for direct memory access.
+- **Thread-safe access**: Read and write operations are protected by a locking mechanism.
+- **Crash resilience**: Changes are immediately reflected in the memory-mapped file.
+- **Data integrity validation**: Validates the file using a magic number.
+
+## 🔧 Installation
+
+To get started with MemoryMap, integrate it directly into your project:
+
+1. In Xcode, select **File** > **Swift Packages** > **Add Package Dependency...**
+2. Enter the repository URL `https://github.com/naftaly/memorymap.git`.
+3. Specify the version or branch you want to use.
+4. Follow the prompts to complete the integration.
+
+## 🚀 Usage
+
+```swift
+import MemoryMap
+
+struct MyData {
+    var counter: Int
+    var flag: Bool
+}
+
+do {
+    let fileURL = URL(fileURLWithPath: "/path/to/memory.map")
+    let memoryMap = try MemoryMap<MyData>(fileURL: fileURL)
+    
+    // Read/write data
+    memoryMap.get.counter = 42
+    memoryMap.get.flag = false
+} catch {
+    print("Error initializing MemoryMap: \(error)")
+}
+```
+
+## 👋 Contributing
+
+Got ideas on how to make MemoryMap even better? We'd love to hear from you! Feel free to fork the repo, push your changes, and open a pull request. You can also open an issue if you run into bugs or have feature suggestions.
+
+## 📄 License
+
+MemoryMap is proudly open-sourced under the MIT License. Dive into the LICENSE file for more details.

Sources/MemoryMap/MemoryMap.swift

@@ -1,5 +1,26 @@
+/// MIT License
+///
+/// Copyright (c) 2024 Alexander Cohen
+///
+/// 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:
+///
+/// The above copyright notice and this permission notice shall be included in all
+/// copies or substantial portions of the Software.
+///
+/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+/// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+/// SOFTWARE.
+
 import Foundation
-import Darwin
 import os
 
 /// MemoryMap is a utility class that backs a Plain Old Data (POD) struct