Add a README.md

Other things

Author: Voltstro

.npmrc

@@ -0,0 +1,2 @@
+registry=https://upm-pkgs.voltstro.dev
+always-auth=true

README.md

@@ -0,0 +1,54 @@
+# Native Array Span Extensions
+
+Provides extensions to Unity's `NativeArray<T>` that make using .NET's Span<T> with them easier
+
+## Features
+
+- Provides theses extensions to `NativeArray<T>`:
+    - `CopyTo` for copying to a `Span<T>`
+    - `CopyFrom` for copying from a `ReadOnlySpan<T>`
+    - Same extensions are also available for `NativeSlice<T>`
+- Provides theses extensions to `Span<T>` and `ReadOnlySpan<T>`:
+    - `CopyTo` for copying a Span to a `NativeArray<T>`
+    - `ToNativeArray` for creating a new `NativeArray<T>` and copying the span's buffer to it
+
+## Getting Started
+
+### Package Installation
+
+#### Prerequisites
+
+```
+Unity 2021.3.x
+```
+
+(Newer Unity versions should be fine as well)
+
+### Installation Methods
+
+There are three main sources on how you can install this package. Pick which ever one suites you the best!
+
+#### Voltstro UPM Registry
+
+You can install this package from our custom UPM registry. To setup our registry, see [here](https://github.com/Voltstro/VoltstroUPM#setup).
+
+Once you have the registry added to your project, you can install it like any other package via the package manager.
+
+#### OpenUPM
+
+You can install this package via [OpenUPM](https://openupm.com/).
+
+To install it, use their CLI:
+
+```bash
+openupm-cli add dev.voltstro.nativearrayspanextensions
+```
+
+#### Git
+
+To install it via the package manager with git you will need to:
+
+1. Open up the package manager via Windows **->** Package Manager
+2. Click on the little + sign **->** Add package from git URL...
+3. Type `https://github.com/Voltstro-Studios/NativeArraySpanExtensions.git` and add it
+4. Unity will now download and install the package

README.md.meta

@@ -1,8 +1,8 @@
 {
-  "name": "dev.voltstro.unitynativearrayspanextensions",
-  "displayName": "Unity Native Array Span Extensions",
+  "name": "dev.voltstro.nativearrayspanextensions",
+  "displayName": "Native Array Span Extensions",
   "version": "1.0.0",
-  "description": "Proves Span/Memory extensions to Unity's NativeArray",
+  "description": "Provides extensions to Unity's NativeArray that make using .NET's Span<T> with them easier",
   "unity": "2021.3",
   "keywords": [
     "native",