Polish PyPI install documentation

Author: 21v-bluecloud

README.md

@@ -7,52 +7,44 @@
 ![CLI First](https://img.shields.io/badge/interface-CLI%20first-1f6feb)
 ![Open Core](https://img.shields.io/badge/model-open%20core-0a7f5a)
 
-NetConfigPulse is an open source engine for backing up network device configurations over SSH. It connects to routers and switches, runs vendor-specific commands, saves the output to disk, and generates diffs against previous backups. Maintained by 21Vianet.
+NetConfigPulse is an open source Python package and CLI for network device configuration backup. It connects to routers and switches over SSH, runs vendor-specific collection commands, saves versioned backup files, and generates diffs against previous runs. Maintained by 21Vianet.
 
 ## Quick Start
 
-Install from the source checkout when developing or running the bundled example
-configuration:
+Install the released package from PyPI:
 
 ```bash
-pip install -e .[dev]
-python -m netconfigpulse validate \
+pip install NetConfigPulse
+netconfigpulse --help
+```
+
+Use the CLI with your own YAML files, or clone the repository and start from the
+sample configuration:
+
+```bash
+netconfigpulse validate \
   --inventory config/devices.example.yaml \
   --commands config/commands.default.yaml \
   --credentials config/credentials.example.yaml \
   --config config/runtime.example.yaml
-pytest tests -q
 ```
 
-This validates the example configuration and runs the test suite. Use `backup`
-only after replacing the example devices and credentials with real values.
+This validates the example configuration without connecting to any device. Use
+`backup` only after replacing the example devices and credentials with real
+values.
 
 ## Installation
 
-From PyPI after the first stable release:
+From PyPI:
 
 ```bash
 pip install NetConfigPulse
 netconfigpulse --help
 ```
 
-From TestPyPI while testing a pre-release package:
-
-```bash
-pip install \
-  --index-url https://test.pypi.org/simple/ \
-  --extra-index-url https://pypi.org/simple/ \
-  NetConfigPulse
-netconfigpulse --help
-```
-
-`--extra-index-url` lets pip download third-party dependencies such as
-`netmiko` and `PyYAML` from the official PyPI index, because TestPyPI is only a
-test package index and may not host those dependencies.
-
-The package install provides the CLI and Python library. To run the example
-configuration files from this repository, clone the repository or copy the
-`config/` directory, then run:
+The PyPI package includes both the `netconfigpulse` console command and the
+Python library API. To run the example configuration files from this repository,
+clone the repository or copy the `config/` directory, then run:
 
 ```bash
 netconfigpulse validate \

README.zh-CN.md

@@ -7,48 +7,40 @@
 ![CLI First](https://img.shields.io/badge/interface-CLI%20first-1f6feb)
 ![Open Core](https://img.shields.io/badge/model-open%20core-0a7f5a)
 
-NetConfigPulse 是一个网络设备配置备份的开源引擎。它通过 SSH 连接到路由器和交换机，执行厂商专属命令，将输出保存到磁盘，并与之前的备份生成 diff 对比。由 21Vianet 维护。
+NetConfigPulse 是一个用于网络设备配置备份的开源 Python 包和 CLI 工具。它通过 SSH 连接路由器和交换机，执行厂商专属采集命令，保存带版本的备份文件，并与历史备份生成 diff 对比。由 21Vianet 维护。
 
 ## 快速开始
 
-开发或运行仓库内置示例配置时，可以从源码目录安装：
+从 PyPI 安装正式发布包：
 
 ```bash
-pip install -e .[dev]
-python -m netconfigpulse validate \
+pip install NetConfigPulse
+netconfigpulse --help
+```
+
+你可以使用自己的 YAML 配置文件运行 CLI，也可以 clone 仓库后从示例配置开始：
+
+```bash
+netconfigpulse validate \
   --inventory config/devices.example.yaml \
   --commands config/commands.default.yaml \
   --credentials config/credentials.example.yaml \
   --config config/runtime.example.yaml
-pytest tests -q
 ```
 
-这组命令会校验示例配置并运行测试。只有在把示例设备和凭据替换为真实值之后，
+这条命令只校验示例配置，不会连接任何设备。只有在把示例设备和凭据替换为真实值之后，
 才建议执行 `backup` 连接真实设备。
 
 ## 安装
 
-正式版本发布到 PyPI 后：
+从 PyPI 安装：
 
 ```bash
 pip install NetConfigPulse
 netconfigpulse --help
 ```
 
-测试预发布包时，可以从 TestPyPI 安装：
-
-```bash
-pip install \
-  --index-url https://test.pypi.org/simple/ \
-  --extra-index-url https://pypi.org/simple/ \
-  NetConfigPulse
-netconfigpulse --help
-```
-
-`--extra-index-url` 用于让 pip 从正式 PyPI 下载 `netmiko`、`PyYAML`
-这类第三方依赖，因为 TestPyPI 只是测试包索引，不一定包含这些依赖。
-
-pip 包会安装 CLI 和 Python 库。如果要直接运行本仓库的示例配置文件，请 clone
+PyPI 包会同时安装 `netconfigpulse` 控制台命令和 Python 库 API。如果要直接运行本仓库的示例配置文件，请 clone
 仓库或复制 `config/` 目录，然后执行：
 
 ```bash

pyproject.toml

@@ -4,8 +4,8 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "NetConfigPulse"
-version = "0.1.0"
-description = "Network configuration backup core engine with CLI-first workflows."
+version = "0.1.1"
+description = "CLI-first Python package for network device configuration backup, versioned snapshots, and diffs."
 readme = "README.md"
 requires-python = ">=3.10"
 license = "Apache-2.0"