Docs: update readme

README.md

@@ -1,30 +1,26 @@
 # TTY::Prompt::Files
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/tty/prompt/files`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-## Installation
-
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
-
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+TTY-Prompt-files is extension for [tty-prompt](https://github.com/piotrmurach/tty-prompt) gem that allow interactive selection elements from file system.
 
 ## Usage
 
-TODO: Write usage instructions here
+**For now**, library support selection **only** non hidden **files** (directories is currently not supported).
+
+```rb
+prompt = TTY::Prompt.new
 
-## Development
+prompt.select_element_from_file_system
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After element is selected, output will be a element full path.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+`select_element_from_file_system` has 3 parameters:
+```rb
+prompt.select_element_from_file_system((pattern: "*", path: ".", text: ""))
+```
+`pattern` is determining for what file will be output based on matching the pattern.
+`path` is determining path of the directory, can be relative or absolute. **Note**: relative **should not** end with `/`.
+`text` is text user will see along with elements.
 
 ## Contributing