Skip to content

Commit e44b071

Browse files
committed
Improve README
1 parent c076114 commit e44b071

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,10 @@ Your task is to create a server that exposes an API to manage subscriptions, cre
44

55
## Description
66

7-
Your server should support:
7+
Your server should expose an API via either [`REST`](https://en.wikipedia.org/wiki/Representational_state_transfer)
8+
or [`graphql`](https://graphql.org/).
9+
10+
The API should support:
811

912
* creating a new subscription for a `msisdn` with an `activate_at` date and a type;
1013
* if a non-cancelled subscription already has the same `msisdn` the request should be rejected;
@@ -23,7 +26,7 @@ A subscription represents a user's phone subscription, which has the following i
2326
* [`msisdn`](https://en.wikipedia.org/wiki/MSISDN) which is the subscription's number;
2427
* `activate_at` which is the date when the subscription is activated in the system;
2528
* `type` which is either [`PBX`](https://en.wikipedia.org/wiki/Business_telephone_system#Private_branch_exchange)
26-
or `CELL`;
29+
or [`CELL`](https://en.wikipedia.org/wiki/Mobile_phone);
2730
* `status` which is one of `pending`, `activated`, `paused` or `cancelled`.
2831

2932
## Submission
@@ -36,7 +39,7 @@ technical skills._
3639

3740
## Requirements
3841

39-
* Your submission should include a `README.md` file documenting how to install and start the project;
42+
* Your submission should include a `README.md` file documenting how to install start and test the project;
4043
* You won't have the time to make everything perfect, just document what is lacking and how you would improve it;
4144
* Do not make the task harder than it is, it should take a couple of hours but absolutely not more than 8 hours;
4245
* You are free to use any technology and framework of your choice.

0 commit comments

Comments
 (0)