Skip to content

Commit ef5c48b

Browse files
committed
Adjusted the readme, check how footnotes are shown in PyPI
1 parent d72bacd commit ef5c48b

2 files changed

Lines changed: 11 additions & 9 deletions

File tree

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
# About
88

9-
`js2pysecrets` is a port of the [`secrets.js`](https://github.com/grempe/secrets.js) JavaScript package to Python.
9+
`js2pysecrets` is a port of the [`secrets.js-grempe`](https://github.com/grempe/secrets.js) JavaScript package to Python.
1010

1111
This package allows for cross-platform compatible shares, *generated using [Shamir's Secret Sharing](http://en.wikipedia.org/wiki/Shamir's_Secret_Sharing)*, to seamlessly interoperate between JavaScript and Python.
1212

@@ -85,14 +85,14 @@ print(shares) # => ['801xxx...xxx','802xxx...xxx', ... ,'804xxx...xxx','805xxx..
8585
# combine 2 shares:
8686
comb = secrets.combine(shares[:2])
8787

88-
//convert back to UTF string:
88+
# convert back to UTF string:
8989
comb = secrets.hex2str(comb)
9090
print(comb == pw) # => False
9191

92-
// combine 3 shares:
92+
# combine 3 shares:
9393
comb = secrets.combine([shares[1], shares[3], shares[4]])
9494

95-
//convert back to UTF string:
95+
# convert back to UTF string:
9696
comb = secrets.hex2str(comb)
9797
print(comb == pw) # => True
9898
```
@@ -103,7 +103,7 @@ print(comb == pw) # => True
103103

104104
## Development and Testing
105105

106-
Read the [CONTRIBUTING.md](CONTRIBUTING.md) file.
106+
Read the [CONTRIBUTING.md](https://github.com/poing/JS2PySecrets/blob/main/CONTRIBUTING.md) file.
107107

108108
## To Do
109109

@@ -116,11 +116,13 @@ Read the [CONTRIBUTING.md](CONTRIBUTING.md) file.
116116
- 0.0.x
117117
- Documentation, documentation, documentation...
118118
- Configured automatic release to PyPI
119-
- Converted `secrets.js` to Python
119+
- Converted `secrets.js`[^1] to Python
120120
- Disabled the `tests_win` GitHub action, #24
121121
- Moved docs to use [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)
122-
- Converted `secrets.js` Jasmine tests to `pytest` versions
122+
- Converted `secrets.js`[^1] Jasmine tests to `pytest` versions
123123
- Added package.json as a stub
124124
- Built Node.js wrapper for testing
125125
- Enable CodeCov
126-
- Started with the [Python Project Template](https://github.com/rochacbruno/python-project-template)
126+
- Started with the [Python Project Template](https://github.com/rochacbruno/python-project-template)
127+
128+
[^1]: `secrets.js-grempe` and `secrets.js` are basically the same. The difference is the environment, JavaScript or Node.js.

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ def read_requirements(path):
3232
setup(
3333
name="js2pysecrets",
3434
version=read("js2pysecrets", "VERSION"),
35-
description="Shamir's Secret Sharing - A port of secrets.js-grempe to Python, allowing cross-platform compatable shares between JavaScript and Python.",
35+
description="Shamir's Secret Sharing - A port of secrets.js-grempe to Python, allowing cross-platform compatible shares between JavaScript and Python.",
3636
url="https://github.com/poing/JS2PySecrets/",
3737
project_urls={
3838
'Documentation': 'https://poing.github.io/JS2PySecrets',

0 commit comments

Comments
 (0)