Skip to content

Commit 3af9266

Browse files
committed
Extend features list
1 parent 4c1799c commit 3af9266

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,48 @@ Nitrokey App 2 requires Python 3.10 or later.
1414

1515
See the [docs](./docs) directory for developer information.
1616

17+
### macOS
18+
19+
Currently there is no official support for macOS, you might want to try installing through [pypi](https://pypi.org/project/nitrokeyapp/) using `pip` and/or `pipx`.
20+
21+
22+
## Features
23+
24+
The following features are currently implemented.
25+
26+
- Firmware update
27+
- Passwords
28+
- TOTP
29+
- HOTP
30+
- Set PIN
31+
- FIDO2
32+
- Passwords
33+
34+
## Download
35+
36+
Executable binaries for Linux and Windows as well as a MSI installer for Windows can be downloaded from the [releases](https://github.com/Nitrokey/nitrokey-app2/releases). Flathub lists the [Nitrokey App2](https://flathub.org/apps/com.nitrokey.nitrokey-app2) to be used for an easy install within your prefered Linux distribution.
37+
38+
### Compiling for Linux and macOS
39+
40+
This project uses [Poetry](https://python-poetry.org/) as its dependency management and packaging system.
41+
See the [documentation](https://python-poetry.org/docs/) of *Poetry* for available commands.
42+
43+
The application can be compiled by executing:
44+
45+
```
46+
git clone https://github.com/Nitrokey/nitrokey-app2.git
47+
cd nitrokey-app2
48+
make init
49+
make build
50+
poetry shell
51+
nitrokeyapp
52+
```
53+
54+
## Dependencies
55+
56+
* [pynitrokey ](https://github.com/Nitrokey/pynitrokey)
57+
* Python >3.9
58+
1759
## Author
1860

1961
Nitrokey GmbH, Jan Suhr and [contributors](https://github.com/Nitrokey/nitrokey-app2/graphs/contributors).

0 commit comments

Comments
 (0)