Skip to content
This repository has been archived by the owner on May 4, 2024. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MatinDevsHere authored Jun 3, 2022
1 parent 591157c commit da55ab0
Showing 1 changed file with 28 additions and 1 deletion.
29 changes: 28 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,29 @@
# takeep
The utility of never getting your texts lost!
The utility πŸ”§ of never getting your texts πŸ“ƒ lost! Takeep is a simple command-line πŸ§‘β€πŸ’» tool that keeps πŸ—ƒοΈ your texts & lets you take them easily πŸ™‚.

# How takeep works?
Takeep is as simple as you can imagine! Add your text to takeep, give it a name, done! Now, you can access your text with 'take' command.

```
> tkp keep -n myToken -c 239840984:sdofum0JDokcdfvjiSiodo
√ Successfully added the item!
> tkp take -n myToken
β–  This is the content of myToken:
239840984:sdofum0JDokcdfvjiSiodo
> tkp list
β–  The list of items of default keepsheet:
myToken
> tkp edit -n myToken -c sdofum0JDokcdfvjiSiodo
√ Successfully edited the item!
> tkp take -n myToken
β–  This is the content of myToken:
sdofum0JDokcdfvjiSiodo
```

# Project files
takeep is written in C# with Visual Studio. Currently, takeep has 2 main projects:
- Takeep.Cli
- Takeep.Core

**Takeep.Cli** is the presentation project. It uses System.CommandLine to handle arguments for app call.
**Takeep.Core** is the core project. It contains methods & functionality of takeep commands.

0 comments on commit da55ab0

Please sign in to comment.