README.md 2.06 KB
Newer Older
1
# lib-ical
Mark Stenglein's avatar
Mark Stenglein committed
2

Mark Stenglein's avatar
Mark Stenglein committed
3
4
![](https://www.gnu.org/graphics/agplv3-155x51.png)

5
6
lib-ical is an npm library which implements the ical standard defined in RFC
5545.
Mark Stenglein's avatar
Mark Stenglein committed
7
8
9

## Getting Started

10
11
12
These instructions will get you a copy of the project up and running on your
local machine for development and testing purposes. See deployment for notes on
how to deploy the project on a live system.
Mark Stenglein's avatar
Mark Stenglein committed
13
14
15

### Prerequisites

16
For this repository, you will need nodejs and npm installed.
Mark Stenglein's avatar
Mark Stenglein committed
17
18
19
20
21
22
23

```
Give examples
```

### Installing

24
25
A step by step series of examples that tell you have to get a development env
running
Mark Stenglein's avatar
Mark Stenglein committed
26
27
28
29
30
31
32
33
34
35
36
37
38

Say what the step will be

```
Give the example
```

And repeat

```
until finished
```

39
40
End with an example of getting some data out of the system or using it for a
little demo
Mark Stenglein's avatar
Mark Stenglein committed
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

## Running the tests

Explain how to run the automated tests for this system

### Break down into end to end tests

Explain what these tests test and why

```
Give an example
```

### And coding style tests

Explain what these tests test and why

```
Give an example
```

## Deployment

Add additional notes about how to deploy this on a live system

## Built With

* [Dropwizard](http://www.dropwizard.io/1.0.2/docs/) - The web framework used
* [Maven](https://maven.apache.org/) - Dependency Management
* [ROME](https://rometools.github.io/rome/) - Used to generate RSS Feeds

## Contributing

74
75
76
77
Please read
[CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426)
for details on our code of conduct, and the process for submitting pull
requests to us.
Mark Stenglein's avatar
Mark Stenglein committed
78
79
80

## Versioning

81
82
We use [SemVer](http://semver.org/) for versioning. For the versions available,
see the [tags on this repository](https://github.com/your/project/tags).
Mark Stenglein's avatar
Mark Stenglein committed
83
84
85

## Authors

86
* **Mark Stenglein** - *Initial work* - [ocelotsloth](https://github.com/ocelotsloth)
Mark Stenglein's avatar
Mark Stenglein committed
87

88
89
See also the list of [contributors](https://git.gmu.edu/srct/lib-ical/contributors)
who participated in this project.
Mark Stenglein's avatar
Mark Stenglein committed
90
91
92

## License

93
94
This project is licensed under the AGPLv3 License - see the [LICENSE](LICENSE)
file for details
Mark Stenglein's avatar
Mark Stenglein committed
95
96
97
98
99
100
101

## Acknowledgments

* Hat tip to anyone who's code was used
* Inspiration
* etc