8000 docs: update readme (#2) · tjosepo/deno_python@4b0bb9a · GitHub
[go: up one dir, main page]
Skip to content

Commit 4b0bb9a

Browse files
eliassjogreeneliassjogreen
authored
docs: update readme (denosaurs#2)
* docs: update readme * fix: related link * docs: fix formatting and nitpicks
1 parent f9b10cd commit 4b0bb9a

File tree

1 file changed

+34
-3
lines changed

1 file changed

+34
-3
lines changed

‎README.md

Lines changed: 34 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# deno_python
22

3+
[![Tags](https://img.shields.io/github/release/denosaurs/deno_python)](https://github.com/denosaurs/deno_python/releases)
4+
[![deno doc](https://doc.deno.land/badge.svg)](https://doc.deno.land/https/deno.land/x/python/mod.ts)
5+
[![checks](https://github.com/denosaurs/deno_python/actions/workflows/checks.yml/badge.svg)](https://github.com/denosaurs/deno_python/actions/workflows/checks.yml)
6+
[![License](https://img.shields.io/github/license/denosaurs/deno_python)](https://github.com/denosaurs/deno_python/blob/master/LICENSE)
7+
38
Python interpreter bindings for Deno.
49

510
```ts
@@ -31,8 +36,34 @@ Python installed from Microsoft Store does not work.
3136
If the module fails to find Python, you can add the path to the Python in the
3237
`DENO_PYTHON_PATH` environment variable.
3338

34-
## License
39+
## Maintainers
40+
41+
- DjDeveloper ([@DjDeveloperr](https://github.com/DjDeveloperr))
42+
- Elias Sjögreen ([@eliassjogreen](https://github.com/eliassjogreen))
43+
44+
## Permission Table
45+
46+
| Permission Needed | Required | Reason |
47+
| ----------------- | -------- | ---------------------------------------------- |
48+
| `--allow-env` | yes | For finding the location of the python library |
49+
| `--allow-run` | yes | For finding the location of the python library |
50+
| `--allow-read` | yes | For reading the library |
51+
| `--allow-ffi` | yes | It uses FFI to interact with python |
52+
| `--unstable` | yes | It's unstable because it uses FFI |
53+
54+
## Other
55+
56+
### Related
57+
58+
- [python](https://www.python.org/)
59+
60+
### Contribution
61+
62+
Pull request, issues and feedback are very welcome. Code style is formatted with
63+
`deno fmt` and commit messages are done following Conventional Commits spec.
64+
65+
### Licence
3566

36-
[Apache 2.0 license](./LICENSE).
67+
Copyright 2021, DjDeveloperr.
3768

38-
Copyright 2021 @ DjDeveloperr
69+
Copyright 2022, the Denosaurs team. All rights reserved. MIT license.

0 commit comments

Comments
 (0)
0