From 34fc7d361844d0a5fe4bb46e69d07866d57eb7b0 Mon Sep 17 00:00:00 2001 From: talksik Date: Thu, 1 Jun 2023 15:36:40 -0700 Subject: [PATCH] adding in readme --- .gitignore | 1 + Cargo.toml | 8 ++++++++ README.md | 22 ++++++++++++++++++++++ src/main.rs | 4 ++++ 4 files changed, 35 insertions(+) create mode 100644 .gitignore create mode 100644 Cargo.toml create mode 100644 README.md create mode 100644 src/main.rs diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ea8c4bf --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/target diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..fe8fe46 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,8 @@ +[package] +name = "rust-tldr-news" +version = "0.1.0" +edition = "2021" + +# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html + +[dependencies] diff --git a/README.md b/README.md new file mode 100644 index 0000000..f0f72a6 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# About + +`rust-tldr-news` is a cli tool to get today’s news via terminal. + +# Installation + +### Git clone + +run `./main` or `cargo run` + +### Improved version later on + +```bash +curl ... | sh +``` + +- puts path variable automatically +- shows list of commands + +# Usage + +Show me today’s news: `rust-tldr today` diff --git a/src/main.rs b/src/main.rs new file mode 100644 index 0000000..7da3a48 --- /dev/null +++ b/src/main.rs @@ -0,0 +1,4 @@ + +fn main() { + println!("Hello, world!"); +}