Skip to content

Commit

Permalink
docs: Update README and License
Browse files Browse the repository at this point in the history
  • Loading branch information
lily4178993 committed Nov 2, 2023
1 parent 9d6e70a commit f22768e
Show file tree
Hide file tree
Showing 2 changed files with 69 additions and 1 deletion.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2023 Nelly Telli
Copyright (c) 2023 Nelly Telli & Ochieng Steven Otieno

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
68 changes: 68 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,70 @@
# RubyPirateTreasureFinder

Unlock the mysteries of the sea and discover hidden pirate treasures with this Ruby script that automates the decryption of Morse code messages found in old bottles during your seaside vacation. Join the adventure now!

## 📗 Table of Contents
- [Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Authors](#authors)
- [Future Features](#future-features)
- [Contributing](#contributing)
- [Show your support](#support)
- [Acknowledgements](#acknowledgements)
- [License](#license)

## Built With <a name="built-with"></a>
- Ruby

## Tech Stack <a name="tech-stack"></a>
- Ruby

## Key Features <a name="key-features"></a>
- Automates the decryption of Morse code messages
- Discover hidden pirate treasures
- Seamlessly integrated with your seaside adventure

## Getting Started <a name="getting-started"></a>
### Prerequisites <a name="prerequisites"></a>
- Ruby installed

### Setup <a name="setup"></a>
- Clone this repository

### Install <a name="install"></a>
- Run `bundle install` to install required gems

## Usage <a name="usage"></a>
- Run the script to decode Morse code messages and uncover the pirate's treasure.

## Authors <a name="authors"></a>
👤 **Ochieng Steven Otieno**

- [GitHub profile](https://github.com/Ochiengsteven)
- [Twitter profile](https://twitter.com/legringo_madd)
- [LinkedIn profile](https://www.linkedin.com/in/steven-ochieng-a43125179/)

👤 **Nelly Telli**

- [GitHub profile](https://github.com/lily4178993)
- [LinkedIn profile](https://www.linkedin.com/in/nellytelli)

## Future Features <a name="future-features"></a>
- No planned future features at this time. The project is complete and functional, but open to community contributions and suggestions for improvements.

## Contributing <a name="contributing"></a>
- Contributions are welcome! Please check the [issues page](https://github.com/lily4178993/RubyPirateTreasureFinder/issues).

## Show your support <a name="support"></a>
- Star this repository if you find it useful!

## Acknowledgments <a name="acknowledgements"></a>
We would like to thank Microverse for this opportunity that allowed us to work on this project.

## License <a name="license"></a>
- This project is licensed under the MIT License - see the [LICENSE file](./LICENSE) for details.

0 comments on commit f22768e

Please sign in to comment.