fix: update all documentation to use onvif-go for consistent branding

- CONTRIBUTING.md: Updated title and git clone URL
- .github/CONTRIBUTING.md: Updated title, paths, and references
- QUICKSTART.md: Updated intro
- BUILDING.md: Updated title
- docs/ARCHITECTURE.md: Updated title and descriptions
- docs/PROJECT_SUMMARY.md: Updated title, description, and structure
- docs/IMPLEMENTATION_SUMMARY.md: Updated docker example
- server/README.md: Updated cd command and link text
- cmd/onvif-diagnostics/README.md: Updated cd command

Note: Kept 'go-onvif' as manufacturer identifier in code (server/types.go, cmd/onvif-server/main.go)
and in code comments (examples/) for descriptive purposes.
This commit is contained in:
ProtoTess
2025-11-17 16:02:48 +00:00
parent f63c77d858
commit eadd0d74f7
9 changed files with 21 additions and 21 deletions
+5 -5
View File
@@ -1,6 +1,6 @@
# Contributing to go-onvif # Contributing to onvif-go
Thank you for your interest in contributing to go-onvif! 🎉 Thank you for your interest in contributing to onvif-go! 🎉
## Code of Conduct ## Code of Conduct
@@ -97,7 +97,7 @@ Help us maintain compatibility information:
```bash ```bash
git clone https://github.com/0x524a/onvif-go.git git clone https://github.com/0x524a/onvif-go.git
cd go-onvif cd onvif-go
go build ./... go build ./...
``` ```
@@ -219,7 +219,7 @@ test: add integration tests for Hikvision cameras
## Project Structure ## Project Structure
``` ```
go-onvif/ onvif-go/
├── client.go # Main ONVIF client ├── client.go # Main ONVIF client
├── types.go # ONVIF type definitions ├── types.go # ONVIF type definitions
├── device.go # Device service ├── device.go # Device service
@@ -272,4 +272,4 @@ By contributing, you agree that your contributions will be licensed under the MI
--- ---
Thank you for contributing to go-onvif! Your efforts help make ONVIF integration better for everyone. 🚀 Thank you for contributing to onvif-go! Your efforts help make ONVIF integration better for everyone. 🚀
+1 -1
View File
@@ -1,4 +1,4 @@
# Building and Releasing go-onvif # Building and Releasing onvif-go
This document describes how to build binaries for multiple platforms and create releases. This document describes how to build binaries for multiple platforms and create releases.
+4 -4
View File
@@ -1,6 +1,6 @@
# Contributing to go-onvif # Contributing to onvif-go
First off, thank you for considering contributing to go-onvif! It's people like you that make go-onvif such a great tool. First off, thank you for considering contributing to onvif-go! It's people like you that make onvif-go such a great tool.
## Code of Conduct ## Code of Conduct
@@ -41,8 +41,8 @@ Enhancement suggestions are tracked as GitHub issues. When creating an enhanceme
```bash ```bash
# Clone your fork # Clone your fork
git clone https://github.com/YOUR_USERNAME/go-onvif.git git clone https://github.com/YOUR_USERNAME/onvif-go.git
cd go-onvif cd onvif-go
# Add upstream remote # Add upstream remote
git remote add upstream https://github.com/0x524a/onvif-go.git git remote add upstream https://github.com/0x524a/onvif-go.git
+1 -1
View File
@@ -1,6 +1,6 @@
# Quick Start Guide # Quick Start Guide
Get up and running with go-onvif in 5 minutes! Get up and running with onvif-go in 5 minutes!
## Installation ## Installation
+1 -1
View File
@@ -33,7 +33,7 @@ A comprehensive diagnostic tool for collecting detailed information from ONVIF c
### Option 1: Build from source ### Option 1: Build from source
```bash ```bash
cd /path/to/go-onvif cd /path/to/onvif-go
go build -o onvif-diagnostics ./cmd/onvif-diagnostics/ go build -o onvif-diagnostics ./cmd/onvif-diagnostics/
``` ```
+3 -3
View File
@@ -1,8 +1,8 @@
# go-onvif Architecture & Design # onvif-go Architecture & Design
## Overview ## Overview
go-onvif is a modern, performant Go library for communicating with ONVIF-compliant IP cameras and devices. It provides a clean, type-safe API with comprehensive support for device management, media streaming, PTZ control, and imaging settings. onvif-go is a modern, performant Go library for communicating with ONVIF-compliant IP cameras and devices. It provides a clean, type-safe API with comprehensive support for device management, media streaming, PTZ control, and imaging settings.
## Architecture ## Architecture
@@ -351,7 +351,7 @@ Minimal external dependencies:
## Conclusion ## Conclusion
go-onvif provides a modern, performant, and easy-to-use Go library for ONVIF camera integration. Its architecture prioritizes: onvif-go provides a modern, performant, and easy-to-use Go library for ONVIF camera integration. Its architecture prioritizes:
- Developer experience (simple, intuitive API) - Developer experience (simple, intuitive API)
- Type safety (compile-time error detection) - Type safety (compile-time error detection)
- Performance (connection pooling, efficient operations) - Performance (connection pooling, efficient operations)
+1 -1
View File
@@ -118,7 +118,7 @@ make build
make docker make docker
# Run container # Run container
docker run -it go-onvif:latest docker run -it onvif-go:latest
``` ```
## 🎯 Key Improvements from Original ## 🎯 Key Improvements from Original
+3 -3
View File
@@ -1,8 +1,8 @@
# Project Summary: go-onvif # Project Summary: onvif-go
## Overview ## Overview
**go-onvif** is a complete refactoring and modernization of the ONVIF library, providing a comprehensive, performant, and developer-friendly Go library for communicating with ONVIF-compliant IP cameras and video devices. **onvif-go** is a complete refactoring and modernization of the ONVIF library, providing a comprehensive, performant, and developer-friendly Go library for communicating with ONVIF-compliant IP cameras and video devices.
## What's Been Created ## What's Been Created
@@ -220,7 +220,7 @@ client.ContinuousMove(ctx, profiles[0].Token, velocity, nil)
## Repository Structure ## Repository Structure
``` ```
go-onvif/ onvif-go/
├── README.md # Main documentation ├── README.md # Main documentation
├── QUICKSTART.md # Getting started guide ├── QUICKSTART.md # Getting started guide
├── ARCHITECTURE.md # Technical design doc ├── ARCHITECTURE.md # Technical design doc
+2 -2
View File
@@ -42,7 +42,7 @@ A complete ONVIF-compliant server implementation that simulates multi-lens IP ca
```bash ```bash
# Clone the repository (if not already done) # Clone the repository (if not already done)
git clone https://github.com/0x524a/onvif-go git clone https://github.com/0x524a/onvif-go
cd go-onvif cd onvif-go
# Build the server CLI # Build the server CLI
go build -o onvif-server ./cmd/onvif-server go build -o onvif-server ./cmd/onvif-server
@@ -430,7 +430,7 @@ This project is licensed under the MIT License - see the [LICENSE](../../LICENSE
## Acknowledgments ## Acknowledgments
- Built on top of the [go-onvif](https://github.com/0x524a/onvif-go) client library - Built on top of the [onvif-go](https://github.com/0x524a/onvif-go) client library
- ONVIF specifications from [ONVIF.org](https://www.onvif.org) - ONVIF specifications from [ONVIF.org](https://www.onvif.org)
- Inspired by the need for flexible camera simulation in development workflows - Inspired by the need for flexible camera simulation in development workflows