Update README.md

2 years ago · f5dd65c709
parent 2472feafad
commit f5dd65c709
1 changed files with 14 additions and 1 deletions
--- a/README.md
+++ b/README.md
@ -1 +1,14 @@
-# ultralytics
+[![Ultralytics CI](https://github.com/ultralytics/ultralytics/actions/workflows/ci.yaml/badge.svg)](https://github.com/ultralytics/ultralytics/actions/workflows/ci.yaml)
+
+### Usage
+
+```bash
+python -m pip install --upgrade pip wheel
+python -m pip install .  # (dev)
+# pip install ultralytics (production)
+
+import ultralytics
+from ultralytics import HUB, YOLO
+
+ultralytics.checks()
+```