docs: update readme and code of conduct

Author: Tschucki

CODE_OF_CONDUCT.md

@@ -61,7 +61,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-[INSERT CONTACT METHOD].
+info@marcelwagner.dev.
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the

README.md

@@ -1,31 +1,113 @@
-# react-native-laravel-sanctum
+# React Native Laravel Sanctum
 
-React Native auth package for Laravel Sanctum integration
+React Native auth package for [Laravel Sanctum ](https://laravel.com/docs/10.x/sanctum) integration. While this package is mainly build for Laravel Sanctum APIs, you can use this library for other API-Backends as well.
+
+## Table of Contents
+
+- [Features](#features)
+- [Installation](#installation)
+- [Basic Usage](#basic-usage)
+- [Example App](#example-app)
+- [Documentation](#documentation)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Features
+
+- [x] Login
+- [x] Logout
+- [x] Get current user
+- [x] Check if user is authenticated
+- [x] CSRF-Token
 
 ## Installation
 
 ```sh
 npm install react-native-laravel-sanctum
 ```
+### Install native dependencies
+As the package relies on `expo-secure-store` you will need to create a new build of your app to use it.
+
+## Basic Usage
 
-## Usage
+Wrap your app with `AuthProvider` and pass the `config` object as a prop.
 
 ```js
-import { multiply } from 'react-native-laravel-sanctum';
+import { AuthProvider } from 'react-native-laravel-sanctum';
 
-// ...
 
-const result = await multiply(3, 7);
+export default function App() {
+  const config = {
+    loginUrl: 'https://your-awesome-domain/api/sanctum/token',
+    logoutUrl: 'https://your-awesome-domain/api/logout',
+    userUrl: 'https://your-awesome-domain/api/user',
+  };
+
+  return (
+    <AuthProvider config={config}>
+      <View>
+        ...
+      </View>
+    </AuthProvider>
+  );
+}
 ```
 
+You can now use the `useAuth` hook within the AuthProvider to access the auth methods.
+    
+```js
+import { useAuth } from 'react-native-laravel-sanctum';
+
+export default function Login() {
+  const { login, getToken, updateUser, setUserIsAuthenticated, isAuthenticated, logout, currentUser } = useAuth();
+  const [email, setEmail] = useState('');
+  const [password, setPassword] = useState('');
+
+  const handleLogin = async () => {
+    const tokenObtained = await login(email, password, 'Test-Device');
+    if (tokenObtained) {
+      const user = await updateUser();
+
+      if (user.id) {
+        setUserIsAuthenticated(true);
+      }
+    }
+  };
+
+  return (
+    <View>
+      <Text >You are not logged in.</Text>
+      <TextInput
+        onChangeText={text => setEmail(text)}
+        value={email}
+        placeholder='Email'
+      />
+      <TextInput
+        onChangeText={text => setPassword(text)}
+        value={password}
+        secureTextEntry
+        placeholder='Password'
+      />
+      <Pressable onPress={handleLogin}>
+        <Text>Login</Text>
+      </Pressable>
+    </View>
+  );
+}
+```
+
+## Example App
+
+You can find the example app [here](https://github.com/Tschucki/react-native-laravel-sanctum-example-app).
+
+## Documentation
+
+You can find the documentation [here](https://github.com/Tschucki/react-native-laravel-sanctum/wiki).
+
 ## Contributing
 
 See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
 
 ## License
 
 MIT
-
----
-
-Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob)