Skip to content

Commit d138ae1

Browse files
committed
readme: Update file to match the current status
Signed-off-by: Andrei Cipu <[email protected]>
1 parent f6d9725 commit d138ae1

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

README.md

+14-11
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
Nitro-cli
1+
## AWS CLI for Nitro Enclaves
22

3-
It contains a collection of tools and commands used for managing the lifecycle
4-
of Nitro Enclaves.
3+
This repository contains a collection of tools and commands used for managing
4+
the lifecycle of Nitro Enclaves.
55

6-
Prerequisites:
6+
### Prerequisites
77
1. A working docker setup, follow https://docs.docker.com/install/overview/
8-
for details of how to install docker on your host.
8+
for details of how to install docker on your host, including how to run it
9+
as non-root.
910
2. Install gcc, make, git.
1011

11-
Driver information:
12-
The Nitro Enclaves device driver is currently at version 0.2. It is based on the
13-
kernel tree head commit b335e6094dff (tag: v0.2, origin/ne-driver-mainline-kernel,
14-
"nitro_enclaves: Add hrtimer support for polling") and supports out-of-tree driver builds.
12+
### Driver information
13+
The Nitro Enclaves kernel driver is currently at version 0.5. Out-of-tree
14+
driver build is supported.
1515

16-
How to install:
16+
### How to install:
1717
1. Clone the repository.
1818
2. Set NITRO_CLI_INSTALL_DIR to the desired location, by default everything will be
1919
installed in build/install
@@ -22,5 +22,8 @@ How to install:
2222
5. [Optional] You could add ${NITRO_CLI_INSTALL_DIR}/etc/profile.d/nitro-cli-env.shenv.sh in you local shell configuration.
2323
6. You are now ready to go.
2424

25-
How to use nitro-cli:
25+
### How to use nitro-cli
2626
TODO: link to official AWS documentation
27+
28+
## License
29+
This library is licensed under the Apache 2.0 License.

0 commit comments

Comments
 (0)