docs(rs): update the README.md and development.md

x-pt · Sep 30, 2024 · fd38885 · fd38885
1 parent 69c56a4
commit fd38885
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 8 deletions.
diff --git a/template/rs/{{cookiecutter.project_slug}}/README.md b/template/rs/{{cookiecutter.project_slug}}/README.md
@@ -1,8 +1,8 @@
-# {{cookiecutter.project_name}}
+# {{cookiecutter.project_slug}}
 
 [![CI](https://github.com/{{cookiecutter.__gh_slug}}/workflows/CI/badge.svg)](https://github.com/{{cookiecutter.__gh_slug}}/actions)
-[![Crates.io](https://img.shields.io/crates/v/{{cookiecutter.project_name}}.svg)](https://crates.io/crates/{{cookiecutter.project_name}})
-[![Documentation](https://docs.rs/{{cookiecutter.project_name}}/badge.svg)](https://docs.rs/{{cookiecutter.project_name}})
+[![Crates.io](https://img.shields.io/crates/v/{{cookiecutter.project_slug}}.svg)](https://crates.io/crates/{{cookiecutter.project_slug}})
+[![Documentation](https://docs.rs/{{cookiecutter.project_slug}}/badge.svg)](https://docs.rs/{{cookiecutter.project_slug}})
 [![License](https://img.shields.io/badge/license-MIT%2FApache--2.0-blue.svg)](README.md#license)
 
 ## Table of Contents
@@ -71,11 +71,11 @@ Add `{{cookiecutter.project_slug}}` to your `Cargo.toml`:
 Here's a brief overview of basic usage:
 
 ```rust
-use {{cookiecutter.project_name}};
+use {{cookiecutter.project_slug}};
 
 fn main() {
     // Example usage
-    let result = {{cookiecutter.project_name}}::do_something();
+    let result = {{cookiecutter.project_slug}}::do_something();
     println!("{:?}", result);
 }
 ```

diff --git a/template/rs/{{cookiecutter.project_slug}}/docs/development.md b/template/rs/{{cookiecutter.project_slug}}/docs/development.md
@@ -1,6 +1,6 @@
-# Development Guide for {{cookiecutter.project_name}}
+# Development Guide for {{cookiecutter.project_slug}}
 
-Welcome to the development guide for `{{cookiecutter.project_name}}`!
+Welcome to the development guide for `{{cookiecutter.project_slug}}`!
 This document will walk you through setting up your development environment, running tests, building the project, and maintaining code quality.
 
 ## Table of Contents
@@ -19,7 +19,7 @@ This document will walk you through setting up your development environment, run
 
     ```bash
     git clone https://github.com/{{cookiecutter.__gh_slug}}.git
-    cd {{cookiecutter.project_name}}
+    cd {{cookiecutter.project_slug}}
     ```
 
 2. **Build the Project**: This command compiles the project and its dependencies: