Skip to content

Commit 5a566ca

Browse files
committed
Enabled github release action and updated readme
1 parent 7195e53 commit 5a566ca

File tree

2 files changed

+33
-25
lines changed

2 files changed

+33
-25
lines changed

.github/workflows/release.yaml

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -119,27 +119,27 @@ jobs:
119119
- name: Publish release distributions to PyPI
120120
uses: pypa/gh-action-pypi-publish@release/v1
121121

122-
# github_release:
123-
# name: Create GitHub Release
124-
# needs: [setup_and_build, details]
125-
# runs-on: ubuntu-latest
126-
# permissions:
127-
# contents: write
128-
# steps:
129-
# - name: Checkout Code
130-
# uses: actions/checkout@v4
131-
# with:
132-
# fetch-depth: 0
133-
134-
# - name: Download artifacts
135-
# uses: actions/download-artifact@v3
136-
# with:
137-
# name: dist
138-
# path: dist/
139-
140-
# - name: Create GitHub Release
141-
# id: create_release
142-
# env:
143-
# GH_TOKEN: ${{ github.token }}
144-
# run: |
145-
# gh release create ${{ needs.details.outputs.tag_name }} dist/* --title ${{ needs.details.outputs.tag_name }} --generate-notes
122+
github_release:
123+
name: Create GitHub Release
124+
needs: [setup_and_build, details]
125+
runs-on: ubuntu-latest
126+
permissions:
127+
contents: write
128+
steps:
129+
- name: Checkout Code
130+
uses: actions/checkout@v4
131+
with:
132+
fetch-depth: 0
133+
134+
- name: Download artifacts
135+
uses: actions/download-artifact@v3
136+
with:
137+
name: dist
138+
path: dist/
139+
140+
- name: Create GitHub Release
141+
id: create_release
142+
env:
143+
GH_TOKEN: ${{ github.token }}
144+
run: |
145+
gh release create ${{ needs.details.outputs.tag_name }} dist/* --title ${{ needs.details.outputs.tag_name }} --generate-notes

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,14 @@ The purpose of this layer is the ability to provide extensive typing information
1717

1818

1919
## Installation
20+
21+
Install from PyPi directly
22+
```
23+
pip3 install HardwareMonitor
24+
```
25+
26+
or install locally from source
27+
2028
```
2129
git clone https://github.com/snip3rnick/PyHardwareMonitor
2230
cd PyHardwareMonitor
@@ -93,7 +101,7 @@ computer.Close()
93101

94102
### Function `ToBuiltinTypes`
95103

96-
Instances from the `HardwareMonitor` module can be reduced to primitive python types instead of `HarwareMonitor` object instances with the `ToBuiltinTypes` function.
104+
Instances from the `HardwareMonitor` module can be reduced to primitive python types instead of `HardwareMonitor` object instances with the `ToBuiltinTypes` function.
97105
Objects are recursively converted to Python builtin types (`dict`, `list`, ...).
98106
This can be useful for applications that serialized the data (e.g. with json).
99107

0 commit comments

Comments
 (0)