diff --git a/Cargo.lock b/Cargo.lock index f44fafef..824ce5c2 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -607,8 +607,8 @@ dependencies = [ ] [[package]] -name = "nyx" -version = "0.1.0" +name = "nyx-scanner" +version = "0.1.1" dependencies = [ "blake3", "bytesize", diff --git a/Cargo.toml b/Cargo.toml index b229d2d2..15158691 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,8 +1,20 @@ [package] -name = "nyx" -version = "0.1.0" +name = "nyx-scanner" +version = "0.1.1" edition = "2024" +description = "A CLI security scanner for automating vulnerability checks" license = "MIT OR Apache-2.0" +authors = ["Eli Peter "] +homepage = "https://github.com/ecpeter23/nyx" +repository = "https://github.com/ecpeter23/nyx" +documentation = "https://github.com/ecpeter23/nyx#readme" +keywords = ["security", "vulnerability", "scanner", "cli", "automation"] +categories = ["command-line-utilities", "development-tools" ] +readme = "README.md" +exclude = [ + "assets/", + ".github/", +] [dev-dependencies] tempfile = "3" diff --git a/README.md b/README.md index b2f7484c..78f7eca9 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,22 @@ +
+ nyx logo + # Nyx -**Nyx** is a lightweight, Rust‑native command‑line tool that detects potentially dangerous code patterns across several programming languages. It combines the accuracy of [`tree‑sitter`](https://tree-sitter.github.io/) parsing with a curated rule set and an optional SQLite‑backed index to deliver fast, repeatable scans on projects of any size. +**Fast, cross-language cli vulnerability scanner.** + +[![release](https://img.shields.io/github/v/release/ecpeter23/nyx?style=flat-square)](https://github.com/ecpeter23/nyx/releases) +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) +[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) +[![Rust](https://img.shields.io/badge/rust-1.70+-orange.svg)](https://www.rust-lang.org) +[![CI](https://img.shields.io/github/actions/workflow/status/ecpeter23/nyx/ci.yml?branch=master)](https://github.com/ecpeter23/nyx/actions) +
+ +--- + +## What is Nyx? + +**Nyx** is a lightweight lightning-fast Rust‑native command‑line tool that detects potentially dangerous code patterns across several programming languages. It combines the accuracy of [`tree‑sitter`](https://tree-sitter.github.io/) parsing with a curated rule set and an optional SQLite‑backed index to deliver fast, repeatable scans on projects of any size. > **Project status – Alpha** > Nyx is under active development. The public interface, rule set, and output formats may change without notice while we stabilize the core. Please pin exact versions in production environments. diff --git a/assets/logo.png b/assets/logo.png new file mode 100644 index 00000000..04c66b71 Binary files /dev/null and b/assets/logo.png differ