From ed92e3c78e2537b346e0c4d6c70360fccd2deeed Mon Sep 17 00:00:00 2001
From: Abdulla Abdurakhmanov <me@abdolence.dev>
Date: Sat, 16 Jul 2022 18:45:21 +0200
Subject: [PATCH] Updated docs

---
 .github/workflows/security-audit.yml | 16 ++++++++++++++++
 .github/workflows/tests.yml          | 13 +++++++++++++
 src/lib.rs                           | 15 +++++++++++++++
 3 files changed, 44 insertions(+)
 create mode 100644 .github/workflows/security-audit.yml
 create mode 100644 .github/workflows/tests.yml

diff --git a/.github/workflows/security-audit.yml b/.github/workflows/security-audit.yml
new file mode 100644
index 0000000..54ef674
--- /dev/null
+++ b/.github/workflows/security-audit.yml
@@ -0,0 +1,16 @@
+name: security audit
+on:
+  push:
+    paths:
+      - '**/Cargo.toml'
+      - '**/Cargo.lock'
+  schedule:
+    - cron: '5 4 * * 6'
+jobs:
+  security_audit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: icepuma/rust-action@master
+        with:
+          args: cargo install cargo-audit && cargo audit || true && cargo audit --ignore RUSTSEC-2020-0159 --ignore RUSTSEC-2020-0071
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
new file mode 100644
index 0000000..00a9fbf
--- /dev/null
+++ b/.github/workflows/tests.yml
@@ -0,0 +1,13 @@
+name: tests & formatting
+on: 
+  push:
+  pull_request:
+    types: [opened]  
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: icepuma/rust-action@master
+        with:
+          args: cargo fmt -- --check && cargo clippy -- -Dwarnings && cargo test
diff --git a/src/lib.rs b/src/lib.rs
index 42d81ea..e7342fa 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,3 +1,18 @@
+//! # Firestore for Rust
+//!
+//! Library provides a simple API for Google Firestore:
+//! - Create or update documents using Rust structures and Serde;
+//! - Support for querying / streaming / listening documents from Firestore;
+//! - Full async based on Tokio runtime;
+//! - Macro that helps you use JSON paths as references to your structure fields;
+//! - Caching Google client based on [gcloud-sdk library](https://github.com/abdolence/gcloud-sdk-rs)
+//!   that automatically detects tokens or GKE environment;
+//!
+//! Examples available at: https://github.com/abdolence/firestore-rs/tree/master/src/examples
+//!
+
+#![allow(clippy::new_without_default)]
+
 pub mod errors;
 mod query;