Skip to content

Commit

Permalink
📝 Add README
Browse files Browse the repository at this point in the history
  • Loading branch information
Lamparter authored Jul 12, 2024
1 parent 941b715 commit 4cc45bb
Showing 1 changed file with 99 additions and 2 deletions.
101 changes: 99 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,99 @@
# SmartTap
A unified solution for emulating NFC cards on Android via Google Wallet. 📱💳
# 💳 Smart Tap

#### A unified solution for emulating NFC cards on Android via Google Wallet.

<p align="center">
<a title="GitHub Releases" target="_blank" href="https://github.com/Lamparter/SmartTap/releases/latest">
<img align="left" src="https://img.shields.io/github/v/release/Lamparter/SmartTap" alt="Release" />
</a>
<a title="Platform" target="_blank">
<img align="left" src="https://img.shields.io/badge/platform-android-green" alt="Platform" />
</a>
</p>

<br/>

---

<!--## 🎁 Download
### 🛍 Play Store
<a title="Microsoft Store" href="https://apps.microsoft.com/store/detail/9PPC02GP33FT">
<img src="https://user-images.githubusercontent.com/76810494/189479518-fc0f18a9-b0a4-4a63-8e7b-27a4284d93af.png" alt="Release" />
</a>
### 😺 GitHub
<a title="GitHub" href='https://github.com/RiversideValley/Emerald/releases/latest'>
<img src='https://user-images.githubusercontent.com/74561130/160255105-5e32f911-574f-4cc4-b90b-8769099086e4.png'alt='Get it from GitHub' />
</a>
### 🔨 Building from source
###### ⭐Recommended⭐
This is our preferred method.
See [this section](#-building-the-code)-->

## 🧑‍💻 Contributing

There are multiple ways to participate in the community:

- [Submit bugs and feature requests](https://github.com/Lamparter/SmartTap/issues/new/choose).
- Review source [code changes](https://github.com/Lamparter/SmartTap/commits)

<!--### 🏗️ Codebase Structure
```
.
└──src // The source code.
├──Esme.Services // Simple computer functions that Esme can complete
└──Esme.Intelligence // Intelligence repository
```
└──Esme.Hypervisor // Simulation software-->

### 🗃️ Contributors

<a href="https://github.com/Lamparter/SmartTap/graphs/contributors">
<img src="https://contrib.rocks/image?repo=Lamparter/SmartTap" />
</a>

## 🦜 Feedback

- [Request a new feature](https://github.com/Lamparter/SmartTap/pulls)
- Upvote popular feature requests
- [File an issue](https://github.com/Lamparter/SmartTap/issues/new/choose)

<!--
## 🔨 Building the Code
##### 1. Prerequisites
Ensure you have following components:
- [Git](https://git-scm.com/)
- [Visual Studio 2022](https://visualstudio.microsoft.com/vs/) with following individual components:
- Python SDK
### 2. Git
Clone the repository:
```git
git clone https://github.com/DepthCDLS/Esmerelda
```
Choose which channel you want via branches. You can choose from either [stable](https://github.com/DepthCDLS/Esmerelda/tree/stable) or [dev](https://github.com/DepthCDLS/Esmerelda/tree/dev).
### 4. Build the project
- Open `Esmerelda.sln`.
- Choose which function you want Esme to start with and right-click on the appropriate project, and select 'Set as startup item'
- Build with `DEBUG|x64`
-->

## ⚖️ License

Copyright (c) 2024 Lamparter

Licensed under the MIT license as stated in the [LICENSE](LICENSE.md).

0 comments on commit 4cc45bb

Please sign in to comment.