mirror of
https://github.com/kunkunsh/kunkun-ext-neohtop.git
synced 2025-04-03 17:36:41 +00:00
chore: Bump version to 1.1.5 and update demo image in README.md
This commit is contained in:
Huakun Shen
parent
80c6029f18
commit
b7d562a3cb
124
README.md
124
README.md
@ -1,123 +1,7 @@
|
||||
# Kunkun Extension for Neohtop
|
||||
|
||||
<div align="center">
|
||||
<img src="app-icon.png" alt="NeoHtop Logo" width="120" />
|
||||
<h1>NeoHtop</h1>
|
||||
<p>A modern, cross-platform system monitor built on top of Svelte, Rust, and Tauri.</p>
|
||||
The this a fork of [neohtop](https://github.com/Abdenasser/neohtop).
|
||||
|
||||
[](https://github.com/Abdenasser/neohtop/blob/main/LICENSE)
|
||||
[](https://github.com/Abdenasser/neohtop/stargazers)
|
||||
[](https://github.com/Abdenasser/neohtop/issues)
|
||||
[](https://github.com/Abdenasser/neohtop/releases)
|
||||
[](https://developer.apple.com/documentation/security/notarizing-macos-software-before-distribution)
|
||||
</div>
|
||||
neohtop is a beautiful Tauri app. Since Kunkun's extension system supports any frontend and provides [system info](https://docs.kunkun.sh/developer/api/sysinfo/) API, it's easy to convert it to a Kunkun extension.
|
||||
|
||||
<div align="center">
|
||||
<picture>
|
||||
<!-- <source media="(prefers-color-scheme: dark)" srcset="screenshot.png">
|
||||
<source media="(prefers-color-scheme: light)" srcset="screenshot-light.png"> -->
|
||||
<img alt="NeoHtop Screenshot" src="./screenshot.png" width="800">
|
||||
</picture>
|
||||
</div>
|
||||
|
||||
<div align="center">
|
||||
<p>If you find this project helpful, consider buying me a coffee:</p>
|
||||
<a href="https://www.buymeacoffee.com/abdenasser" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" ></a>
|
||||
<p>Or sponsor me on GitHub:</p>
|
||||
<a href="https://github.com/sponsors/Abdenasser" target="_blank"><img src="https://img.shields.io/badge/Sponsor-abdenasser-white?style=flat&logo=github&logoColor=pink" alt="Sponsor @abdenasser" style="height: auto !important;width: 217px !important;"></a>
|
||||
|
||||
</div>
|
||||
|
||||
## Table of Contents
|
||||
- [Why NeoHtop?](#why-neohtop)
|
||||
- [Features](#features)
|
||||
- [Tech Stack](#tech-stack)
|
||||
- [Getting Started](#getting-started)
|
||||
- [Prerequisites](#prerequisites)
|
||||
- [Installation](#installation)
|
||||
- [Running with Sudo](#running-with-sudo)
|
||||
- [Development](#development)
|
||||
- [Setup](#setup)
|
||||
- [Code Formatting](#code-formatting)
|
||||
- [Pull Requests](#pull-requests)
|
||||
- [Contributing](#contributing)
|
||||
- [License](#license)
|
||||
|
||||
## Why NeoHtop?
|
||||
[Read about the back story and motivation behind NeoHtop](https://www.abdenasser.com/2024/11/06/oh-boy-neohtop/)
|
||||
|
||||
## Features
|
||||
- 🚀 Real-time process monitoring
|
||||
- 💻 CPU and Memory usage tracking
|
||||
- 🎨 Beautiful, modern UI with dark/light themes
|
||||
- 🔍 Advanced process search and filtering
|
||||
- 📌 Pin important processes
|
||||
- 🛠 Process management (kill processes)
|
||||
- 🎯 Sort by any column
|
||||
- 🔄 Auto-refresh system stats
|
||||
|
||||
### Search Functionality
|
||||
Search for processes by name, command, or PID. Use commas to search for multiple terms simultaneously. Regular expressions are supported for advanced filtering.
|
||||
|
||||
Examples:
|
||||
- `arm, x86`: Returns processes with "arm" or "x86" in the name or command
|
||||
- `d$`: Lists daemons (processes ending with 'd')
|
||||
- `^(\w+\.)+\w+$`: Shows processes with reverse domain name notation (e.g., com.docker.vmnetd)
|
||||
|
||||
## Tech Stack
|
||||
- **Frontend**: SvelteKit, TypeScript
|
||||
- **Backend**: Rust, Tauri
|
||||
- **Styling**: CSS Variables for theming
|
||||
- **Icons**: FontAwesome
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
- Node.js (v16 or later)
|
||||
- Rust (latest stable)
|
||||
- Xcode Command Line Tools (for macOS)
|
||||
|
||||
### Installation
|
||||
Download the latest release from the [releases page](https://github.com/Abdenasser/neohtop/releases).
|
||||
|
||||
### Running with Sudo
|
||||
Some processes require monitoring with sudo privileges. To monitor these processes, launch NeoHtop with sudo:
|
||||
|
||||
- macOS: `sudo /Applications/NeoHtop.app/Contents/MacOS/NeoHtop`
|
||||
- Linux: `pkexec /path/to/neohtop` (recommended)
|
||||
|
||||
## Development
|
||||
|
||||
### Setup
|
||||
```bash
|
||||
# Install dependencies
|
||||
npm install
|
||||
|
||||
# Run in development mode
|
||||
npm run tauri dev
|
||||
|
||||
# Build for production
|
||||
npm run tauri build
|
||||
```
|
||||
|
||||
### Code Formatting
|
||||
We use Prettier for web code and `cargo fmt` for Rust code.
|
||||
|
||||
```bash
|
||||
# Format all files
|
||||
npm run format
|
||||
|
||||
# Check formatting without making changes
|
||||
npm run format:check
|
||||
```
|
||||
|
||||
### Pull Requests
|
||||
Before submitting a PR, ensure:
|
||||
1. All code is formatted (`npm run format`)
|
||||
2. The format check passes (`npm run format:check`)
|
||||
3. Your commits follow the project's commit message conventions
|
||||
|
||||
## Contributing
|
||||
We welcome contributions! Please see our [contributing guidelines](./.github/CONTRIBUTING.md) for more information.
|
||||
|
||||
## License
|
||||
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
||||
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
"type": "git",
|
||||
"url": "https://github.com/kunkunsh/kunkun-ext-neohtop.git"
|
||||
},
|
||||
"version": "1.1.4",
|
||||
"version": "1.1.5",
|
||||
"description": "",
|
||||
"type": "module",
|
||||
"kunkun": {
|
||||
@ -14,7 +14,7 @@
|
||||
"longDescription": "A modern, cross-platform system monitor",
|
||||
"identifier": "neohtop",
|
||||
"demoImages": [
|
||||
"https://i.imgur.com/z2XWAPi.jpeg"
|
||||
"https://imgur.com/D8VHDEz.png"
|
||||
],
|
||||
"permissions": [
|
||||
"system-info:all"
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user