From 07e2a056186b4ef385b5ad221b9d269f685f5d29 Mon Sep 17 00:00:00 2001
From: Arindam Karmakar <arindamk410@gmail.com>
Date: Wed, 9 Oct 2024 03:34:45 +0530
Subject: [PATCH] SUMMARY: 	1. Added initial README.md file 	2.
 Removed index.html from root

---
 README.md  | 68 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 index.html |  1 -
 2 files changed, 68 insertions(+), 1 deletion(-)
 create mode 100644 README.md
 delete mode 100644 index.html

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1043585
--- /dev/null
+++ b/README.md
@@ -0,0 +1,68 @@
+# SwiftNP
+
+SwiftNP is a Swift package for numerical computing inspired by the popular Python library, NumPy. It provides support for multi-dimensional arrays (NDArray), along with basic operations on these arrays, such as reshaping, element-wise operations, and more.
+
+## Features
+
+- Multi-dimensional arrays (`NDArray`)
+- Support for various numeric types (e.g., `Int`, `Float`, `Double`, etc.)
+- Basic array operations (reshape, element-wise operations, etc.)
+- Extensible architecture for additional numerical computing functionality
+
+## Installation
+
+### Swift Package Manager
+
+Add the following to your `Package.swift` file:
+
+```swift
+dependencies: [
+    .package(url: "https://github.com/yourusername/SwiftNP", from: "1.0.0")
+]
+```
+
+Then, include SwiftNP as a dependency in your target:
+
+```swift
+.target(
+    name: "YourTarget",
+    dependencies: ["SwiftNP"]),
+```
+
+Import SwiftNP
+
+In any Swift file where you want to use SwiftNP:
+
+```swift
+import SwiftNP
+```
+
+Usage
+
+Creating an NDArray
+
+You can create a multi-dimensional array by specifying the shape and default values:
+
+```swift
+let array = SNP.ones(shape: [1, 3, 512, 512])
+```
+
+Basic Array Operations
+
+SwiftNP supports element-wise operations, reshaping, and much more:
+
+```swift
+let reshapedArray = array.reshape([1, 9])
+```
+
+Data Types
+
+SwiftNP supports a wide range of numeric data types. You can specify the data type when creating an NDArray:
+
+```swift
+let floatArray = NDArray(shape: [2, 2], dtype: .float64, defaultValue: 21.0)
+```
+
+License
+
+This project is licensed under the MIT License. See the LICENSE file for details.
\ No newline at end of file
diff --git a/index.html b/index.html
deleted file mode 100644
index fa12f0c..0000000
--- a/index.html
+++ /dev/null
@@ -1 +0,0 @@
-<h1>Hello World from SwiftNP</h1>