Skip to content

Commit c83f5e5

Browse files
committed
chore: update rust-starter references
1 parent 6485728 commit c83f5e5

File tree

16 files changed

+42
-473
lines changed

16 files changed

+42
-473
lines changed

.clog.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[clog]
2-
repository = "https://github.com/omarabid/rust-starter"
2+
repository = "https://github.com/CodeInputCorp/cli"
33
outfile = "CHANGELOG.md"
44
from-latest-tag = true
55

CHANGELOG.md

Lines changed: 0 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1 @@
1-
<a name=""></a>
2-
## (2019-11-01)
3-
4-
5-
#### Features
6-
7-
* **Logging:** add support for scoped, async logging ([da9395e2](https://github.com/omarabid/rust-starter/commit/da9395e24c26b99977f09ec26742d8966232cfee))
8-
* **clap:** Basic Clap integration. ([02d14410](https://github.com/omarabid/rust-starter/commit/02d14410bc437c06014f1d829e7c1c156d6d07e6))
9-
* **config:**
10-
* implement global config with RwLock ([b5cf5ef8](https://github.com/omarabid/rust-starter/commit/b5cf5ef8eec1e76d0b13f9beac5b61100a8ec4a9))
11-
* initial config implementation ([21c0f7be](https://github.com/omarabid/rust-starter/commit/21c0f7bed2173719749394917598d720ee1ee7f6))
12-
* **docker:** Initial Docker integration ([6c84c7d2](https://github.com/omarabid/rust-starter/commit/6c84c7d232b58e7036f9b4e6b4e4feacac2f5105))
13-
* **hazard:** Add a sample command ([e6380f4b](https://github.com/omarabid/rust-starter/commit/e6380f4b5acbc2332735581aa9aafb22338d9418))
14-
* **human_panic:** Add human_panic library ([2cef587e](https://github.com/omarabid/rust-starter/commit/2cef587e64947ffb143ff3afb006dc019ba52483))
15-
* **logging:** implement slog_syslog logging ([73ba1bf4](https://github.com/omarabid/rust-starter/commit/73ba1bf4541661da55e7969c1718034e070d5776))
16-
17-
#### Improvements
18-
19-
* **Cargo:** initialize Rust library ([b974094f](https://github.com/omarabid/rust-starter/commit/b974094f73967178f16defa224853e8f7bad2792))
20-
* **config:**
21-
* refactor AppConfig to allow get/set for a single property ([64da0c58](https://github.com/omarabid/rust-starter/commit/64da0c5802013c4e57ace611d023d3ec3d8138b0))
22-
* beautify the config output ([b0bb7004](https://github.com/omarabid/rust-starter/commit/b0bb7004650a4a5d878501177eb87da9feea5bf1))
23-
* **core:** add error conversion for slog-syslog ([0d00c2cc](https://github.com/omarabid/rust-starter/commit/0d00c2cc99d02b4868b19ab5f8812a1ecf6974f1))
24-
* **dependencies:** replace serde_derive crate by serde with derive feature ([13f8077b](https://github.com/omarabid/rust-starter/commit/13f8077b765ab5835dedc8aa19b2ac960800b831))
25-
* **error:**
26-
* add a sample error ([fd1a8805](https://github.com/omarabid/rust-starter/commit/fd1a88050391774927d29f1345f6a190a81c2412))
27-
* Initial implementation for error.rs ([df931484](https://github.com/omarabid/rust-starter/commit/df9314848f14e8c71643703d982ed93398c47cf1))
28-
* **human_panic:** only include human panic in release builds ([75910c6a](https://github.com/omarabid/rust-starter/commit/75910c6afb614720c5dc692694f4b1bce46f4895))
29-
* **tests:** remove unwrap from tests ([ae070a8d](https://github.com/omarabid/rust-starter/commit/ae070a8d4f35a31b07ba3b7e14024e1499a7e46a))
30-
31-
#### Bug Fixes
32-
33-
* **config:** make config properties visible ([b8499e9a](https://github.com/omarabid/rust-starter/commit/b8499e9a089490c862fb7ae59e1b5e0e2ae9a2f8))
34-
* **error:** add error chaining for AppConfig init ([09fc01b3](https://github.com/omarabid/rust-starter/commit/09fc01b3f386691e85752f6ea45b073c9a41e5f4))
35-
* **slog:** Temporarily disable logging ([c7c48b80](https://github.com/omarabid/rust-starter/commit/c7c48b80ddba7daefb072a8761b4a5691a1e40f0), breaks [#](https://github.com/omarabid/rust-starter/issues/))
36-
37-
#### Documentation
38-
39-
* **CONTR:** Brief update to CONTRIBUTING.md ([81b114c8](https://github.com/omarabid/rust-starter/commit/81b114c859054bd83c9db6200448942d6f4296e8))
40-
* **CONTRIBUTING.md:** first iteration ([6fddae33](https://github.com/omarabid/rust-starter/commit/6fddae337a3b30799c6814165fb13b888df5c56f))
41-
* **ISSUE_TEMPLATE.md:** First iteration ([f02d0772](https://github.com/omarabid/rust-starter/commit/f02d07725229463ade2e8d81be1c73b79ef17530))
42-
* **README:** A brief update for README ([f3c02033](https://github.com/omarabid/rust-starter/commit/f3c02033572d051cd824b706950b5bacf8e09475))
43-
* **badge:**
44-
* Gitter Community badge ([19b899bb](https://github.com/omarabid/rust-starter/commit/19b899bb50e7c03dde14131d5fad1c049aae8f79))
45-
* Circleci Badge ([aa6119c1](https://github.com/omarabid/rust-starter/commit/aa6119c1b92bdb7040b3f6df3d5f91c39e48ebe0))
46-
* **comments:** add a few random comments ([5c28f8e9](https://github.com/omarabid/rust-starter/commit/5c28f8e981e36e2fa0d1496922c271ddcd68749b))
47-
48-
#### Breaking Changes
49-
50-
* **slog:** Temporarily disable logging ([c7c48b80](https://github.com/omarabid/rust-starter/commit/c7c48b80ddba7daefb072a8761b4a5691a1e40f0), breaks [#](https://github.com/omarabid/rust-starter/issues/))
51-
52-
531

Cargo.toml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
[package]
2-
name = "rust-starter"
3-
version = "2.0.1"
2+
name = "codeinput"
3+
version = "0.0.1"
44
authors = ["Abid Omar <contact@omarabid.com>"]
5-
edition = "2021"
6-
repository = "https://github.com/omarabid/rust-starter"
5+
edition = "2024"
6+
repository = "https://github.com/CodeInputCorp/cli"
77
readme = "README.md"
88
license = "MIT"
9-
keywords = ["cli", "starter"]
9+
keywords = ["cli", "codeinput", "git", "tooling"]
1010
description = """
11-
Rust Starter aims to provide high quality components to bootstrap your Rust CLI Project. It includes a battery of most used libraries; and defines a set of Rust best practices.
11+
.
1212
"""
1313

1414
[workspace]

README.md

Lines changed: 11 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,24 @@
1-
<p align="center">
2-
<a href="https://rust-starter.github.io"><img src="https://raw.githubusercontent.com/rust-starter/rust-starter.github.io/master/docs/images/logo_color.png" height="100px"/></a>
3-
</p>
4-
<h1 align="center">rust-starter</h1>
1+
<h1 align="center">codeinput</h1>
52
<div align="center">
63
<strong>
7-
A simple framework to build Rust CLI Applications
4+
codeinput CLI
85
</strong>
96
</div>
107
<br/>
118

12-
[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/omarabid/rust-starter/blob/master/LICENSE) [![Gitter](https://badges.gitter.im/rust-starter/community.svg)](https://gitter.im/rust-starter/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
13-
[![Tests](https://github.com/rust-starter/rust-starter/actions/workflows/tests.yml/badge.svg)](https://github.com/rust-starter/rust-starter/actions/workflows/tests.yml)
14-
[![Build](https://github.com/rust-starter/rust-starter/actions/workflows/build.yml/badge.svg)](https://github.com/rust-starter/rust-starter/actions/workflows/build.yml)
15-
[![codecov](https://codecov.io/gh/rust-starter/rust-starter/branch/master/graph/badge.svg)](https://codecov.io/gh/rust-starter/rust-starter)
9+
[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/CodeInputCorp/cli/blob/master/LICENSE)
10+
[![Tests](https://github.com/CodeInputCorp/cli/actions/workflows/tests.yml/badge.svg)](https://github.com/CodeInputCorp/cli/actions/workflows/tests.yml)
11+
[![Build](https://github.com/CodeInputCorp/cli/actions/workflows/build.yml/badge.svg)](https://github.com/CodeInputCorp/cli/actions/workflows/build.yml)
1612

17-
[Website](https://rust-starter.github.io)
18-
19-
`rust-starter` is a starter boilerplate to create a Rust CLI application. It comes with a battery of components like argument parsing and configuration. It also has different tooling to create your binary, or automate your build process.
13+
`codeinput` is a CLI for [codeinput](https://codeinput.com).
2014

2115
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
2216
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
17+
2318
**Table of Contents**
2419

2520
- [What's New?](#whats-new)
26-
- [Version 2.0.0](#version-200)
21+
- [Version 2.0.0](#version-200)
2722
- [About](#about)
2823
- [FAQ](#faq)
2924
- [Features](#features)
@@ -34,57 +29,18 @@
3429

3530
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
3631

37-
## What's New?
38-
39-
#### Version 2.0.0
40-
41-
What's new in Version 2.0?
42-
43-
- [x] Upgrade to Clap 4.x
44-
- [x] Shell Completion
45-
- [x] Merge AppConfig with Clap/Cli arguments
46-
- [x] use ConfigBuilder instead of Config
47-
- [x] rustfmt update
48-
- [x] Github release action
49-
50-
Planned for a 2.x release
51-
52-
- [x] Journald/Syslog as features
53-
- [x] Fix CI/CD actions and Docker image
54-
5532
## About
5633

57-
`rust-starter` is an empty Rust CLI application with libraries, and few defaults. The goal is to help you bootstrap your next CLI project as quickly as possible while ensuring you make use of the best tools and best-practices that are available today.
58-
59-
There is no configuration required (though we recommend you check all the possible configurations possible). An empty clone will compile, and has a few sample commands. You can start coding right away!
60-
61-
## FAQ
62-
63-
For the Full FAQ, check the [website](https://rust-starter.github.io/#faq)
64-
65-
## Features
66-
67-
- [Clap](https://github.com/clap-rs/clap) for Command Line Argument parsing.
68-
- Error Chaining with [Failure](https://github.com/rust-lang-nursery/failure).
69-
- Configuration management with [config-rs](https://github.com/mehcode/config-rs).
70-
- Multi-Drain, async Logging with [slog](https://github.com/slog-rs/slog).
71-
- Static binaries with [rust-musl-builder](https://github.com/emk/rust-musl-builder).
72-
- CI/CD through Github actions.
73-
- Code Coverage, Justfile, etc..
74-
- MIT License.
75-
76-
## Quick Bootstrapping
77-
78-
`rust-starter` should compile and run as is. You just need to clone the repository. A `cargo-generate` template is also [available](https://github.com/rust-starter/rust-starter-generate). For a more detailed introduction, check the [Getting Started](https://rust-starter.github.io/#getting-started) guide.
34+
`codeinput` is a CLI for [codeinput](https://codeinput.com).
7935

8036
## How to Contribute
8137

8238
Details on how to contribute can be found in the [CONTRIBUTING.md](.github/CONTRIBUTING.md) file.
8339

8440
### Versioning
8541

86-
Rust Starter stricltly adheres to the [SemVer](https://semver.org/) Semantic Versioning.
42+
codeinput adheres to the [SemVer](https://semver.org/) Semantic Versioning.
8743

8844
## License
8945

90-
`rust-starter` is licensed under the MIT license. Please read the [LICENSE](LICENSE) file in this repository for more information.
46+
`codeinput` is licensed under the MIT license. Please read the [LICENSE](LICENSE) file in this repository for more information.

SECURITY.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
## Report a security issue
22

3-
The Rust-Starter project welcomes security reports and is committed to providing prompt attention to security issues. Security issues should be reported privately via [rust@omarabid.com](mailto:rust@omarabid.com). Security issues should not be reported via the public Github Issue tracker.
3+
codeinput clip welcomes security reports and is committed to providing prompt attention to security issues. Security issues should be reported privately via [security@codeinput.com](mailto:security@codeinput.com). Security issues should not be reported via the public Github Issue tracker.
44

55
## Vulnerability coordination
66

7-
Remediation of security vulnerabilities is prioritized by the project team. The project team coordinates remediation with third-party project stakeholders via [Github Security Advisories](https://help.github.com/en/github/managing-security-vulnerabilities/about-github-security-advisories). Third-party stakeholders may include the reporter of the issue, affected direct or indirect users of Rust-Starter, and maintainers of upstream dependencies if applicable.
7+
Remediation of security vulnerabilities is prioritized by the project team. The project team coordinates remediation with third-party project stakeholders via [Github Security Advisories](https://help.github.com/en/github/managing-security-vulnerabilities/about-github-security-advisories). Third-party stakeholders may include the reporter of the issue, affected direct or indirect users of codeinput, and maintainers of upstream dependencies if applicable.
88

99
## Security advisories
1010

11-
The project team is committed to transparency in the security issue disclosure process. We announce security issues via [project Github Release notes](https://github.com/omarabid/rust-starter/releases).
11+
The project team is committed to transparency in the security issue disclosure process. We announce security issues via [project Github Release notes](https://github.com/CodeInputCorp/cli/releases).

0 commit comments

Comments
 (0)