This is an automated email from the ASF dual-hosted git repository.
dehowef pushed a commit to branch AGE_driver_swift
in repository https://gitbox.apache.org/repos/asf/age.git
The following commit(s) were added to refs/heads/AGE_driver_swift by this push:
new c81d5437 AGE Swift Driver: Readme updated (#942)
c81d5437 is described below
commit c81d5437f059aa4f00c17c1adf4c27d5cc2a606f
Author: Fahad Zaheer <[email protected]>
AuthorDate: Wed May 31 01:32:47 2023 +0500
AGE Swift Driver: Readme updated (#942)
AGE Swift Driver: Readme updated
Age Swift Driver: License added to Readme
---
drivers/age-swift/README.md | 60 ++++++++++++++++++++++++++++++---------------
1 file changed, 40 insertions(+), 20 deletions(-)
diff --git a/drivers/age-swift/README.md b/drivers/age-swift/README.md
index 42b8cef2..65f3ed88 100644
--- a/drivers/age-swift/README.md
+++ b/drivers/age-swift/README.md
@@ -1,20 +1,40 @@
-# Licensed to the Apache Software Foundation (ASF) under one
-# or more contributor license agreements. See the NOTICE file
-# distributed with this work for additional information
-# regarding copyright ownership. The ASF licenses this file
-# to you under the Apache License, Version 2.0 (the
-# "License"); you may not use this file except in compliance
-# with the License. You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing,
-# software distributed under the License is distributed on an
-# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-# KIND, either express or implied. See the License for the
-# specific language governing permissions and limitations
-# under the License.
-
-# age-swift
-
-Apache Age Driver for Swift.
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+
+# Apache Age Swift Driver
+
+The Apache Age Swift Driver is a library that allows Swift developers to
interact with Apache Age, a graph database built on top of PostgreSQL. This
driver leverages the capabilities of the PostgresClientKit library to provide a
seamless integration with Apache Age and enables the execution of basic
PostgreSQL operations.
+
+## Features
+
+- Connect to an Apache Age graph database using a PostgresClientKit connection.
+- Execute basic PostgreSQL operations such as querying, inserting, updating,
and deleting data.
+- Utilize the power of Apache Age's graph database capabilities to perform
graph-specific operations.
+- Leverage the familiar syntax and functionality of Swift while interacting
with the Apache Age database.
+
+## Prerequisites
+
+Before using the Apache Age Swift Driver, ensure that you have the following
prerequisites installed:
+
+- Swift 5.0 or later
+- Apache Age
+- PostgreSQL
+
+## Installation
+
+You can add the Apache Age Swift Driver to your Swift project using Swift
Package Manager (SPM).
+
+## Test
+A sample is created in age_swiftTests.swift
\ No newline at end of file
