Skip to content

shreyaslad/readrust

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

41 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Readrust

A simple command line tool written in Rust to get articles from https://readrust.net

Build Status

General Info

Name: ReadRust

Version: 1.0.2-beta.3

Author: PenetratingShot

Documentation

Installation

Step 1, Option 1. Clone the repository
$ git clone https://github.com/PenetratingShot/readrust.git
Step 1, Option 2. Download the zip file
Go to the releases and download the zip file.
Step 2. Navigate to the directory
Go to the path ./target/release/readrust
Step 3. Run the script.
Double click on the file and select you command prompt as the application to open it. Once it says [Process Completed], you may close the tab.
Step 4. Open a new command prompt tab
Open a new tab or instance of you local command prompt and try running the command: readrust -h or readrust --help

Usage

Note: You may NOT combine different flags together. They are meant to be used individually for the time being. Attempting to do so will return the output for the first flag and ignore the second.

Flag Alias Usage
--help –h Prints help information
--about –a About the project
--version –v Prints version information
--count –c Show the count of posts
--devops –d Feed from DevOps and Deployment
--performance –p Feed from Performance
--rust2018 –r Feed from Rust2018

Example Function: $ readrust --devops

This command will return the feed from the devops section on readrust


License

Readrust is licensed under the MIT License