You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The README should be addressed to somebody who's never seen this before.
22
+
But also don't assume that they're a novice.
23
+
-->
24
+
The at_contact package is for Flutter developers who would like to persist contacts in their @platform application. The at_contact library provides features to add, update, and delete contacts on the @platform.
25
+
26
+
<!---
27
+
Give some context and state the intent - we welcome contributions - we want
28
+
pull requests and to hear about issues. Include the boilerplate language
29
+
below to add some context to @platform packages
30
+
-->
31
+
This open source package is written in Dart, supports Flutter and follows the
32
+
@platform's decentralized, edge computing model with the following features:
33
+
- Cryptographic control of data access through personal data stores
34
+
- No application backend needed
35
+
- End to end encryption where only the data owner has the keys
36
+
- Private and surveillance free connectivity
37
+
38
+
We call giving people control of access to their data “flipping the internet”
39
+
and you can learn more about how it works by reading this
40
+
[overview](https://atsign.dev/docs/overview/).
41
+
42
+
<!---
43
+
Does this package publish to pub.dev or similar? This README will be the
44
+
first thing that developers see there and should be written such that it
45
+
lets them quickly assess if it fits their need.
46
+
-->
47
+
## Get started
48
+
There are three options to get started using this package.
49
+
50
+
<!---
51
+
If the package has a template that at_app uses to generate a skeleton app,
52
+
that is the quickest way for a developer to assess it and get going with
53
+
their app.
54
+
-->
55
+
<!-- ### 1. Quick start - generate a skeleton app with at_app
56
+
This package includes a working sample application in the
57
+
[Example](./example) directory that you can use to create a personalized
58
+
copy using ```at_app create``` in four commands.
59
+
60
+
```sh
61
+
$ flutter pub global activate at_app
62
+
$ at_app create --sample=<package ID> <app name>
63
+
$ cd <app name>
64
+
$ flutter run
65
+
```
66
+
Notes:
67
+
1. You only need to run ```flutter pub global activate``` once
68
+
2. Use ```at_app.bat``` for Windows -->
69
+
70
+
71
+
<!---
72
+
Cloning the repo and example app from GitHub is the next option for a
73
+
developer to get started.
74
+
-->
75
+
### 1. Clone it from GitHub
76
+
<!---
77
+
Make sure to edit the link below to refer to your package repo.
78
+
-->
79
+
Feel free to fork a copy of the source from the [GitHub repo](https://github.com/atsign-foundation/at_libraries).
The last option is to use the traditionaL instructions for adding the package to a project which can be found on pub.dev.
87
+
Please be sure to replace the package name in the url below the right one for this package.
88
+
-->
89
+
### 2. Manually add the package to a project
10
90
11
-
at_contact library persists contacts across different @platform applications. at_contact library provides a contact feature where we can add a new contact. Update/delete an existing contact.
12
-
**at_contact** package is written in Dart.
91
+
Instructions on how to manually add this package to you project can be found on pub.dev [here](https://pub.dev/packages/at_client/install).
13
92
14
-
## Get Started
93
+
<!---
94
+
Include an explanation on how to setup and use the package
95
+
-->
96
+
## How it works
15
97
16
-
Initially to get a basic overview of the @protocol packages, You must read the [atsign docs](https://atsign.dev/docs/overview/).
98
+
<!---
99
+
Add details on how to setup the package
100
+
-->
101
+
### Setup
17
102
18
-
> To use this package you must be having a basic setup, Follow here to [get started](https://atsign.dev/docs/get-started/setup-your-env/).
103
+
```sh
104
+
$ dart pub add at_contact
19
105
20
-
# Usage
106
+
```
107
+
### Usage
21
108
22
109
- Create an instance of `AtContactsImpl`, We make use of `AtClientManager` for `AtClient` to be passed.
- So far we have looked into contacts, Now let us know how `AtGroup`s to be used.
130
217
@@ -295,8 +382,60 @@ print(atSign + ' is ${isAMember ? '' : 'not'} a member of ' + myGroup.groupName)
295
382
// @somerandomatsign is not a member of The @Platform team
296
383
```
297
384
298
-
## Additional content
385
+
For more information, please see the API documentation listed on pub.dev.
386
+
387
+
<!---
388
+
If we have any pages for these docs on atsign.dev site, it would be
389
+
good to add links.(optional)
390
+
-->
391
+
### Additional content
299
392
300
393
- We have developed some realtime Applications using this library called [@mosphere-pro](https://atsign.com/apps/atmosphere-pro/), [@buzz](https://atsign.com/apps/buzz/), [@rrive (Google play store)](https://play.google.com/store/apps/details?id=com.atsign.arrive) / [@rrive (App Store)](https://apps.apple.com/in/app/rrive/id1542050548).
301
394
302
395
- Flutter implementation of this library can be found in [at_contacts_flutter](https://pub.dev/packages/at_contacts_flutter) package.
396
+
<!---
397
+
You should include language like below if you would like others to contribute
398
+
to your package.
399
+
-->
400
+
401
+
## Open source usage and contributions
402
+
This is open source code, so feel free to use it as is, suggest changes or
403
+
enhancements or create your own version. See [CONTRIBUTING.md](CONTRIBUTING.md)
404
+
for detailed guidance on how to setup tools, tests and make a pull request.
405
+
406
+
<!---
407
+
Have we correctly acknowledged the work of others (and their Trademarks etc.)
408
+
where appropriate (per the conditions of their LICENSE?
409
+
-->
410
+
<!-- ## Acknowledgement/attribution -->
411
+
412
+
<!---
413
+
Who created this?
414
+
Do they have complete GitHub profiles?
415
+
How can they be contacted?
416
+
Who is going to respond to pull requests?
417
+
-->
418
+
<!-- ## Maintainers -->
419
+
420
+
<!---
421
+
## Checklist
422
+
423
+
- [ ] Writing and style
424
+
Does the writing flow, with proper grammar and correct spelling?
425
+
426
+
- [ ] SEO
427
+
Always keep in mind that developers will often use search to find solutions
428
+
to their needs. Make sure and add in terms that will help get this package to
429
+
the top of the search results for google, pub.dev and medium.com as a minimum.
430
+
431
+
- [ ] Links
432
+
Are the links to external resources correct?
433
+
Are the links to other parts of the project correct
434
+
(beware stuff carried over from previous repos where the
435
+
project might have lived during earlier development)?
436
+
437
+
- [ ] LICENSE
438
+
Which LICENSE are we using?
439
+
Is the LICENSE(.md) file present?
440
+
Does it have the correct dates, legal entities etc.?
0 commit comments