upd: version, readme

ic-it · Sep 30, 2023 · 606f85b · 606f85b
1 parent 2313e97
commit 606f85b
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 11 deletions.
diff --git a/Makefile b/Makefile
@@ -1,4 +1,4 @@
-APP_VERSION=0.1.7
+APP_VERSION=0.1.8
 APP_PATH=simplepcap
 APP_TEST_PATH=tests
 
@@ -53,13 +53,11 @@ run-docs:
 	@mkdocs serve
 
 
-# Update App Version in README.md, pyproject.toml, docs/index.md, simplepcap/__init__.py
+# Update App Version in pyproject.toml, simplepcap/__init__.py
 update-version:
 	@echo "$(INFO) Updating app version..."
-	@sed -i 's/version-[0-9]\.[0-9]\.[0-9]-blue/version-$(APP_VERSION)-blue/g' README.md
 	@sed -i 's/version = "[0-9]\.[0-9]\.[0-9]"/version = "$(APP_VERSION)"/g' pyproject.toml
 	@sed -i 's/version-[0-9]\.[0-9]\.[0-9]-blue/version-$(APP_VERSION)-blue/g' docs/index.md
-	@sed -i 's/__version__ = "[0-9]\.[0-9]\.[0-9]"/__version__ = "$(APP_VERSION)"/g' simplepcap/__init__.py
 	@echo "$(OK) App version updated to $(APP_VERSION)"
 
 

diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Simple PCAP file parser
 
-![SimplePCAP. Logo Author: @mellin_venera](./docs/assets/images/minilogo.png)  
+![SimplePCAP. Logo Author: @mellin_venera](https://ic-it.github.io/simplepcap/assets/images/minilogo.png)  
 [
     ![lint](https://img.shields.io/github/actions/workflow/status/ic-it/simplepcap/lint.yml)
 ](https://github.com/ic-it/simplepcap/actions)
@@ -21,8 +21,8 @@
     ![Documentation Status](https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat)
 ](https://ic-it.github.io/simplepcap/)
 [
-    ![Version](https://img.shields.io/badge/version-0.1.7-blue)
-](https://github.com/ic-it/simplepcap)
+    ![PyPI](https://img.shields.io/pypi/v/simplepcap)
+](https://pypi.org/project/simplepcap/)
 
 > Based on [this](https://www.ietf.org/archive/id/draft-gharris-opsawg-pcap-01.html) 
 > and [this](https://wiki.wireshark.org/Development/LibpcapFileFormat#global-header) 
@@ -35,6 +35,12 @@ tools for analyzing packages. The library tries to provide the safest possible m
 
 
 ## Installation
+### From PyPI
+```bash
+pip install simplepcap
+```
+
+### From GitHub
 ```bash
 pip install git+https://github.com/ic-it/simplepcap.git
 ```

diff --git a/docs/index.md b/docs/index.md
@@ -21,8 +21,8 @@
     ![Documentation Status](https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat)
 ](https://ic-it.github.io/simplepcap/)
 [
-    ![Version](https://img.shields.io/badge/version-0.1.7-blue)
-](https://github.com/ic-it/simplepcap)
+    ![PyPI](https://img.shields.io/pypi/v/simplepcap)
+](https://pypi.org/project/simplepcap/)
 
 > Based on [this](https://www.ietf.org/archive/id/draft-gharris-opsawg-pcap-01.html) 
 > and [this](https://wiki.wireshark.org/Development/LibpcapFileFormat#global-header) 
@@ -35,6 +35,12 @@ tools for analyzing packages. The library tries to provide the safest possible m
 
 
 ## Installation
+### From PyPI
+```bash
+pip install simplepcap
+```
+
+### From GitHub
 ```bash
 pip install git+https://github.com/ic-it/simplepcap.git
 ```

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [project]
 name = "simplepcap"
-version = "0.1.7"
+version = "0.1.8"
 description = "A simple pcap library for Python"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -61,6 +61,7 @@ publish = [
 
 [project.urls]
 "Homepage" = "https://ic-it.github.io/simplepcap/"
+"Documentation" = "https://ic-it.github.io/simplepcap/"
 "Bug Reports" = "https://github.com/ic-it/simplepcap/issues"
 "Source Code" = "https://github.com/ic-it/simplepcap"
 

diff --git a/simplepcap/__init__.py b/simplepcap/__init__.py
@@ -1,4 +1,4 @@
-__version__ = "0.1.7"
+__version__ = "0.1.8"
 
 from .types import Version, Reserved, FileHeader, PacketHeader, Packet
 from .parser import Parser