From 9f9bf7b54475f88b384a8dc7c47adff276ad4bf7 Mon Sep 17 00:00:00 2001
From: Elijas <4084885+Elijas@users.noreply.github.com>
Date: Thu, 12 Oct 2023 06:17:00 +0300
Subject: [PATCH] docs: add comment

---
 README.md                  | 2 ++
 nbs/index.ipynb            | 8 +++++---
 sec_downloader/__init__.py | 2 +-
 settings.ini               | 2 +-
 4 files changed, 9 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 78d978e..3a7af28 100644
--- a/README.md
+++ b/README.md
@@ -33,6 +33,7 @@ storage = DownloadStorage()
 with storage as path:
     dl = Downloader("MyCompanyName", "email@example.com", path)
     dl.get("10-K", "GOOG", limit=2)
+# all files are now deleted and only stored in memory
 
 for path, content in storage.get_file_contents():
     print(f"Path: {path}\nContent [len={len(content)}]: {content[:30]}...\n")
@@ -54,6 +55,7 @@ storage = DownloadStorage(filter_pattern=ONLY_HTML)
 with storage as path:
     dl = Downloader("MyCompanyName", "email@example.com", path)
     dl.get("10-Q", "AAPL", limit=1, download_details=True)
+# all files are now deleted and only stored in memory
 
 content = storage.get_file_contents()[0].content
 print(f"{content[:50]}...")
diff --git a/nbs/index.ipynb b/nbs/index.ipynb
index 3b72986..81217c4 100644
--- a/nbs/index.ipynb
+++ b/nbs/index.ipynb
@@ -2,7 +2,7 @@
  "cells": [
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": null,
    "metadata": {},
    "outputs": [
     {
@@ -115,7 +115,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": null,
    "metadata": {},
    "outputs": [
     {
@@ -139,6 +139,7 @@
     "with storage as path:\n",
     "    dl = Downloader(\"MyCompanyName\", \"email@example.com\", path)\n",
     "    dl.get(\"10-K\", \"GOOG\", limit=2)\n",
+    "# all files are now deleted and only stored in memory\n",
     "\n",
     "for path, content in storage.get_file_contents():\n",
     "    print(f\"Path: {path}\\nContent [len={len(content)}]: {content[:30]}...\\n\")"
@@ -154,7 +155,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": null,
    "metadata": {},
    "outputs": [
     {
@@ -172,6 +173,7 @@
     "with storage as path:\n",
     "    dl = Downloader(\"MyCompanyName\", \"email@example.com\", path)\n",
     "    dl.get(\"10-Q\", \"AAPL\", limit=1, download_details=True)\n",
+    "# all files are now deleted and only stored in memory\n",
     "\n",
     "content = storage.get_file_contents()[0].content\n",
     "print(f\"{content[:50]}...\")"
diff --git a/sec_downloader/__init__.py b/sec_downloader/__init__.py
index 7b97ad7..0e728ce 100644
--- a/sec_downloader/__init__.py
+++ b/sec_downloader/__init__.py
@@ -1,4 +1,4 @@
-__version__ = "0.1.0"
+__version__ = "0.1.1"
 from sec_downloader.core import DownloadStorage, FileContent
 
 __all__ = ["DownloadStorage", "FileContent"]
diff --git a/settings.ini b/settings.ini
index 57198e3..8603c56 100644
--- a/settings.ini
+++ b/settings.ini
@@ -1,7 +1,7 @@
 [DEFAULT]
 repo = sec-downloader
 lib_name = sec-downloader
-version = 0.1.0
+version = 0.1.1
 min_python = 3.7
 license = mit
 black_formatting = False