mirror of
/repos/rpi-node.git
synced 2025-12-30 08:01:30 +01:00
improved readme
This commit is contained in:
parent
738144baa3
commit
c662ef3c92
32
README.md
32
README.md
@ -3,6 +3,12 @@ Raspberry Pi compatible Docker base image with Node.js preinstalled.
|
||||
|
||||
Run all the commands from within the project root directory.
|
||||
|
||||
### Build Details
|
||||
- [Source Project Page](https://github.com/hypriot)
|
||||
- [Source Repository](https://github.com/hypriot/rpi-node)
|
||||
- [Dockerfile](https://github.com/hypriot/rpi-node/blob/master/Dockerfile)
|
||||
|
||||
|
||||
#### Build the Docker Image
|
||||
```bash
|
||||
make build
|
||||
@ -16,6 +22,32 @@ make version
|
||||
#### Push the Docker Image to the Docker Hub
|
||||
* First use a `docker login` with username, password and email address
|
||||
* Second push the Docker Image to the official Docker Hub
|
||||
|
||||
```bash
|
||||
make push
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2015 Hypriot
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user