Update the README with instructions for pip installing; start the changelog
- ID
57337c5- date
2024-08-24 08:50:13+00:00- author
Alex Chan <alex@alexwlchan.net>- parent
c1de350- message
Update the README with instructions for pip installing; start the changelog Closes #3- changed files
3 files, 15 additions, 4 deletions
Changed files
CHANGELOG.md (0) → CHANGELOG.md (93)
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..200369b
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,5 @@
+# CHANGELOG
+
+## v0.0.1 - 2024-08-24
+
+Initial release on PyPI, to test the release mechanism.
README.md (1589) → README.md (1566)
diff --git a/README.md b/README.md
index 244bf48..d0a8187 100644
--- a/README.md
+++ b/README.md
@@ -19,10 +19,16 @@ Think of this module as the JSON module, but for JavaScript files.
## Installation
-Copy the file `src/javascript` folder into your project.
-You probably want to copy the tests as well.
+You have two options:
-Eventually this will be a pip installable package, once I've done some more testing (see [issue #3](https://github.com/alexwlchan/python-js-files/issues/3)).
+1. Copy the file `src/javascript` folder into your project.
+ You probably want to copy the tests as well.
+
+2. Install the package using pip:
+
+ ```console
+ $ pip install alexwlchan-python-js-files
+ ```
## Why not use JSON files?
src/javascript/__init__.py (4638) → src/javascript/__init__.py (4638)
diff --git a/src/javascript/__init__.py b/src/javascript/__init__.py
index b0bdd3c..6ef7501 100644
--- a/src/javascript/__init__.py
+++ b/src/javascript/__init__.py
@@ -5,7 +5,7 @@ import re
import typing
-__version__ = "1.0.0"
+__version__ = "0.0.1"
def read_js(p: pathlib.Path | str, *, varname: str) -> typing.Any: