From b6cca0869aec4d8770d68a7433268e5b7c1a330d Mon Sep 17 00:00:00 2001
From: Thomas Zeutschler <thomas.zeutschler@gmail.com>
Date: Mon, 23 Sep 2024 13:57:14 +0200
Subject: [PATCH] readme updated

---
 .idea/workspace.xml | 49 +++++++++++++++++++++++----------------------
 readme.md           | 30 ++++++++++++++-------------
 2 files changed, 41 insertions(+), 38 deletions(-)

diff --git a/.idea/workspace.xml b/.idea/workspace.xml
index 995e0e0..1a6f874 100644
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -4,9 +4,9 @@
     <option name="autoReloadType" value="SELECTIVE" />
   </component>
   <component name="ChangeListManager">
-    <list default="true" id="cbdc4bb4-dd76-47cb-8ea0-4be0a7f6860e" name="Changes" comment="datespan added">
+    <list default="true" id="cbdc4bb4-dd76-47cb-8ea0-4be0a7f6860e" name="Changes" comment="sample updated">
       <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/cubedpandas/__init__.py" beforeDir="false" afterPath="$PROJECT_DIR$/cubedpandas/__init__.py" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/readme.md" beforeDir="false" afterPath="$PROJECT_DIR$/readme.md" afterDir="false" />
     </list>
     <option name="SHOW_DIALOG" value="false" />
     <option name="HIGHLIGHT_CONFLICTS" value="true" />
@@ -165,7 +165,7 @@
     "RunOnceActivity.ShowReadmeOnStart": "true",
     "com.codeium.enabled": "true",
     "git-widget-placeholder": "dev",
-    "last_opened_file_path": "/Users/thomas/Documents/Coding/cubedpandas/tests/datasets",
+    "last_opened_file_path": "/Users/thomas/Documents/Coding/cubedpandas/samples/datasets",
     "node.js.detected.package.eslint": "true",
     "node.js.detected.package.tslint": "true",
     "node.js.selected.package.eslint": "(autodetect)",
@@ -178,11 +178,11 @@
 }]]></component>
   <component name="RecentsManager">
     <key name="CopyFile.RECENT_KEYS">
+      <recent name="$PROJECT_DIR$/samples/datasets" />
+      <recent name="$PROJECT_DIR$/samples" />
       <recent name="$PROJECT_DIR$/tests/datasets" />
       <recent name="$PROJECT_DIR$/cubedpandas/datetext/tokenizer" />
       <recent name="$PROJECT_DIR$/tests" />
-      <recent name="$PROJECT_DIR$/.github/workflows" />
-      <recent name="$PROJECT_DIR$/docs/guides" />
     </key>
     <key name="MoveFile.RECENT_KEYS">
       <recent name="$PROJECT_DIR$/tests" />
@@ -363,23 +363,7 @@
       <workItem from="1726858898122" duration="563000" />
       <workItem from="1726859482478" duration="82000" />
       <workItem from="1726909312725" duration="3723000" />
-      <workItem from="1727024561444" duration="16745000" />
-    </task>
-    <task id="LOCAL-00025" summary="slice refactored">
-      <option name="closed" value="true" />
-      <created>1725651492711</created>
-      <option name="number" value="00025" />
-      <option name="presentableId" value="LOCAL-00025" />
-      <option name="project" value="LOCAL" />
-      <updated>1725651492711</updated>
-    </task>
-    <task id="LOCAL-00026" summary="datetime features">
-      <option name="closed" value="true" />
-      <created>1725809578886</created>
-      <option name="number" value="00026" />
-      <option name="presentableId" value="LOCAL-00026" />
-      <option name="project" value="LOCAL" />
-      <updated>1725809578886</updated>
+      <workItem from="1727024561444" duration="18045000" />
     </task>
     <task id="LOCAL-00027" summary="datetime features">
       <option name="closed" value="true" />
@@ -757,7 +741,23 @@
       <option name="project" value="LOCAL" />
       <updated>1727090606197</updated>
     </task>
-    <option name="localTasksCounter" value="74" />
+    <task id="LOCAL-00074" summary="datespan added">
+      <option name="closed" value="true" />
+      <created>1727091329583</created>
+      <option name="number" value="00074" />
+      <option name="presentableId" value="LOCAL-00074" />
+      <option name="project" value="LOCAL" />
+      <updated>1727091329583</updated>
+    </task>
+    <task id="LOCAL-00075" summary="sample updated">
+      <option name="closed" value="true" />
+      <created>1727092062913</created>
+      <option name="number" value="00075" />
+      <option name="presentableId" value="LOCAL-00075" />
+      <option name="project" value="LOCAL" />
+      <updated>1727092062913</updated>
+    </task>
+    <option name="localTasksCounter" value="76" />
     <servers />
   </component>
   <component name="TypeScriptGeneratedFilesManager">
@@ -789,7 +789,8 @@
     <MESSAGE value="DateSpan &amp; DateFilter added" />
     <MESSAGE value="DateSpan &amp; DateFilter carved out to separate project 'DateSpanLib' https://github.com/Zeutschler/DateSpanLib" />
     <MESSAGE value="datespan added" />
-    <option name="LAST_COMMIT_MESSAGE" value="datespan added" />
+    <MESSAGE value="sample updated" />
+    <option name="LAST_COMMIT_MESSAGE" value="sample updated" />
     <option name="REFORMAT_BEFORE_PROJECT_COMMIT" value="true" />
   </component>
   <component name="XDebuggerManager">
diff --git a/readme.md b/readme.md
index 773425b..28438dc 100644
--- a/readme.md
+++ b/readme.md
@@ -26,31 +26,33 @@ maintainable code, e.g. this Pandas code:
 
 ```python
 # Pandas: calculate the total revenue of all hybrid Audi cars in September 2024
-value = df.loc[(df['make'] == 'Audi') &
-               (df['engine'] == 'hybrid') &
-               (df['date'] >= '2024-09-01') & (df['date'] <= '2024-09-30'),
-'price'].sum()
+value = df.loc[
+    (df['make'] == 'Audi') &
+    (df['engine'] == 'hybrid') &
+    (df['date'] >= '2024-09-01') & (df['date'] <= '2024-09-30'),
+    'revenue'
+].sum()
 ```
 
 can turn into this equivalent CubedPandas code:
 
 ```python
 # ...the same with CubedPandas:
-value = df.cubed.make.Audi.engine.hybrid.date.september_2024.price
+value = df.cubed.make.Audi.engine.hybrid.date.september_2024.revenue
 
-# ...or even shorter
-value = df.cubed.Audi.hybrid.sep_2024.price
+# ...or maybe even shorter:
+value = df.cubed.Audi.hybrid.sep_2024
 ```
 
-CubedPandas offers a fluent interface based on the data available in the underlying DataFrame
-for easy filtering, navigation and analysis of Pandas dataframes.
+CubedPandas offers a fluent interface based on the data available in the underlying DataFrame.
+So, filtering, navigation and analysis of Pandas dataframes becomes more intuitive, more readable and more fun.
 
-CubedPandas neither duplicates data nor modifies the underlying DataFrame, and it introduces no
-performance penalty. In fact, it can significantly speed up your data processing.
+CubedPandas neither duplicates data nor modifies the underlying DataFrame, and it introduces
+no performance penalty. In fact, it can sometimes significantly speed up your data processing.
 
-[Jupyter notebooks](https://jupyter.org) is the perfect habitat for CubedPandas.
-For further information, please visit the [CubedPandas Documentation](https://zeutschler.github.io/cubedpandas/)
-or try the included samples.
+[Jupyter notebooks](https://jupyter.org) is the perfect habitat for CubedPandas. For further information,
+please visit the [CubedPandas Documentation](https://zeutschler.github.io/cubedpandas/)
+or try some of the included samples.
 
 ### Getting Started