|
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> |
5 | 2 | <div align="center"> |
6 | 3 | <strong> |
7 | | - A simple framework to build Rust CLI Applications |
| 4 | + codeinput CLI |
8 | 5 | </strong> |
9 | 6 | </div> |
10 | 7 | <br/> |
11 | 8 |
|
12 | | -[](https://github.com/omarabid/rust-starter/blob/master/LICENSE) [](https://gitter.im/rust-starter/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) |
13 | | -[](https://github.com/rust-starter/rust-starter/actions/workflows/tests.yml) |
14 | | -[](https://github.com/rust-starter/rust-starter/actions/workflows/build.yml) |
15 | | -[](https://codecov.io/gh/rust-starter/rust-starter) |
| 9 | +[](https://github.com/CodeInputCorp/cli/blob/master/LICENSE) |
| 10 | +[](https://github.com/CodeInputCorp/cli/actions/workflows/tests.yml) |
| 11 | +[](https://github.com/CodeInputCorp/cli/actions/workflows/build.yml) |
16 | 12 |
|
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). |
20 | 14 |
|
21 | 15 | <!-- START doctoc generated TOC please keep comment here to allow auto update --> |
22 | 16 | <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> |
| 17 | + |
23 | 18 | **Table of Contents** |
24 | 19 |
|
25 | 20 | - [What's New?](#whats-new) |
26 | | - - [Version 2.0.0](#version-200) |
| 21 | + - [Version 2.0.0](#version-200) |
27 | 22 | - [About](#about) |
28 | 23 | - [FAQ](#faq) |
29 | 24 | - [Features](#features) |
|
34 | 29 |
|
35 | 30 | <!-- END doctoc generated TOC please keep comment here to allow auto update --> |
36 | 31 |
|
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 | | - |
55 | 32 | ## About |
56 | 33 |
|
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). |
79 | 35 |
|
80 | 36 | ## How to Contribute |
81 | 37 |
|
82 | 38 | Details on how to contribute can be found in the [CONTRIBUTING.md](.github/CONTRIBUTING.md) file. |
83 | 39 |
|
84 | 40 | ### Versioning |
85 | 41 |
|
86 | | -Rust Starter stricltly adheres to the [SemVer](https://semver.org/) Semantic Versioning. |
| 42 | +codeinput adheres to the [SemVer](https://semver.org/) Semantic Versioning. |
87 | 43 |
|
88 | 44 | ## License |
89 | 45 |
|
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. |
0 commit comments