Skip to content

Commit

Permalink
Update the README to 2023
Browse files Browse the repository at this point in the history
  • Loading branch information
martinpaljak committed Oct 31, 2023
1 parent 8f0ac22 commit 0bd29b6
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# FiDeSMo Utility · [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/fidesmo/fdsm/blob/master/LICENSE) [![Build Status](https://github.com/fidesmo/fdsm/workflows/Continuous%20Integration/badge.svg?branch=master)](https://github.com/fidesmo/fdsm/actions) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.fidesmo/fdsm/badge.svg)](https://mvnrepository.com/artifact/com.fidesmo/fdsm) [![Release]( https://img.shields.io/github/release/fidesmo/fdsm/all.svg)](https://github.com/fidesmo/fdsm/releases)

FDSM is _the_ developer's Swiss Army Knife for working with a [Fidesmo device](https://www.fidesmo.com/fidesmo/devices/) and the [Fidesmo API](https://developer.fidesmo.com/api). It supersedes [gradle-fidesmo](https://github.com/fidesmo/gradle-fidesmo) for interacting with the Fidesmo API and provides an alternative to [Fidesmo Android app](https://play.google.com/store/apps/details?id=com.fidesmo.sec.android) when delivering services to a device via a PC/SC reader (contact or contactless). All from the command line.
FDSM is _the_ developer's Swiss Army Knife for working with a [Fidesmo device](https://fidesmo.com/consumer/wearables/) and the [Fidesmo API](https://developer.fidesmo.com/api). It provides an alternative to [Fidesmo Android app](https://play.google.com/store/apps/details?id=com.fidesmo.sec.android) when delivering services to a device via a PC/SC reader (contact or contactless). All from the command line.

# Getting started

You will need the following:
- Latest [Java 11](https://adoptopenjdk.net/) for running the app
- a [Fidesmo Developer account](https://developer.fidesmo.com) for your `$FIDESMO_AUTH` (`appId:appKey`)
- a [Fidesmo Developer account](https://fidesmo.com/book-demo/) for your `$FIDESMO_AUTH` token and `$FIDESMO_APPID`
- a Fidesmo device (get one from the [shop](http://shop.fidesmo.com))
- a PC/SC NFC reader (unless your developer device is the [Yubikey NEO with Fidesmo](http://shop.fidesmo.com/product/yubikey-neo-with-fidesmo))
- a [PC/SC NFC reader](https://github.com/fidesmo/fdsm/wiki/Choosing-a-desktop-reader)

Grab a copy of `fdsm.jar` (or `fdsm.exe` wrapper for Windows) from the [release area](https://github.com/fidesmo/fdsm/releases). It is an executable JAR file, so start by running

Expand All @@ -20,7 +20,7 @@ or `fdsm.exe -h` on Windows. With Linux or macOS, it is recommended to add a han


## HOWTO
FDSM should be easy to use for [JavaCard developers](https://developer.fidesmo.com/fidesmo-for-card-developers) with some knowledge of the Fidesmo API. We will cover the full development cycle with the following HOWTO-s
FDSM should be easy to use for [JavaCard developers](https://fidesmo.com/technology/java-card/) with some knowledge of the Fidesmo API. We will cover the full development cycle with the following HOWTO-s

1. [Develop and build your JavaCard applet](https://github.com/fidesmo/fdsm/wiki/Applet-Development) with [`ant-javacard`](https://github.com/martinpaljak/ant-javacard)
2. [Test your applet on a Fidesmo device](https://github.com/fidesmo/fdsm/wiki/Install-and-Personalize) with `fdsm`
Expand Down Expand Up @@ -52,4 +52,5 @@ command line arguments but some behavior can be tuned by setting environment
variables.

- `FIDESMO_AUTH` - user and password, or token. Equivalent of using `--auth user:password` or `--auth token`
- `FIDESMO_API_URL` - the URL of the the Fidesmo backend (do not change if unsure)
- `FIDESMO_API_URL` - the URL of the Fidesmo backend (do not change if unsure)
- `FIDESMO_APPID` - the Application ID to use. Equivalent of using `--app-id <id>`

0 comments on commit 0bd29b6

Please sign in to comment.