Updated readme

MarcelFerrari · Feb 9, 2023 · 0f53c30 · 0f53c30
1 parent f0054f8
commit 0f53c30
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 2 deletions.
diff --git a/AUTHORS b/AUTHORS
@@ -0,0 +1,3 @@
+Marcel Ferrari
+BSc. student of Computational Science @ ETHZ Switzerland
+[email protected]
diff --git a/README.md b/README.md
@@ -35,10 +35,10 @@ Once the library is installed, you can start using it in your Python projects or
 ### Basic usage
 This script defines the most basic usage of the library. The raw data must be imported in the database only once.
 ```py
-from PandaSQLite import PandaSQLite
+from PandaSQLite import PandaSQLiteDB
 
 # Create/open database
-db = PandaSQLite("my_database.sql")
+db = PandaSQLiteDB("my_database.sql")
 
 # Import raw data -- must only be done once!
 
@@ -57,6 +57,9 @@ df = db.query("SELECT * FROM \"table_1\"")
 
 For a more comprehensive showcase of features, check out the examples in the examples directory to get started.
 
+### Documentation
+The documentation for PandaSQLite is [available here](https://github.com/MarcelFerrari/PandaSQLite/wiki)
+
 ### Common problems
 `TypeError: 'NoneType' object is not iterable`:<br>
 This issue is usually caused by executing a query with no return data in the `db.query()` function, which should only be used for queries that return a table ("SELECT" queries). Use the `db.execute()` function for queries with no return data (e.g: "INSERT", "UPDATE", "ALTER", ... queries).

diff --git a/example/documentation/example.sqlite3 b/example/documentation/example.sqlite3