Giter VIP home page Giter VIP logo

metaxa's Introduction

metaxa ๐Ÿธ

npm NPM

CLI made for fast reading, showing only one word at a time.

๐Ÿ‘‡ demo

demo

๐Ÿ’พ Installation

npm i -g metaxa

๐Ÿ”Œ Usage

  1. Show text from file in < file_path > with delay between words in < delay > (default 250WPM)
metaxa start <path> [<delay>]

or

npx metaxa start <path> [<delay>]

where < path > is a path to your .txt file with text to read and < delay > is the speed of the words in words per minute (WPM)

  1. Show number of words, sentences, and absolute path of file in < file_path >
metaxa stats <file_path>
  1. Show text from text wrapped with '' or "" in < text >, with delay between words in < delay > (default 250WPM)
metaxa read <text> [<delay>] 

๐Ÿ“ฝ๏ธ See it in action!

demo

๐Ÿ™Œ Contributing

Contributions are welcome, check Issues!

If you like the project make sure to hit โญ

โœจ Contributors

Checkout our Contributors

๐Ÿ“ƒ License

This project is under MIT license

metaxa's People

Contributors

ashutoshjv661 avatar bofalke avatar cychu42 avatar itslukedev avatar j3ns3n avatar jsvigneshkanna avatar makoteq avatar meerhamzadev avatar neilan99 avatar sayedsajadhosseini avatar sb-decoder avatar tanmoysrt avatar yazh1202 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

metaxa's Issues

Update README.md

Readme needs updated documentation for all newly introduced commands

Add option to paste text

Add option for user to paste text directly into the shell, as alternative for specifying path

Words number

An option to allow setting the number of words to be shown

-version command

There should be -version and -v command added that respond with current package version
This one should be implemented inside index.js file

Create stats command

Create "stats" command:
syntax:
metaxa stats <path>
where is path to specified file for which user what to get statistic

Statistic to show:

  • number of words
  • number of sentences
  • absolute path of file

CONTRIBUTING.md file

Add a CONTRIBUTING.md file with some basic contribution guidelines, how to setup project

Change colors

Change colors to keep everything consistent.
One color for header and one for content

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.