Skip to content

Commit c68c8a4

Browse files
committed
update readme and contribution page
1 parent bf29288 commit c68c8a4

File tree

2 files changed

+11
-39
lines changed

2 files changed

+11
-39
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Contributing to CoCreateJS
1+
# Contributing to CoCreate-email
22

33
This project is work of [many contributors](https://github.com/CoCreate-app/CoCreate-email/graphs/contributors).
44
You're encouraged to submit [pull requests](https://github.com/CoCreate-app/CoCreate-email/pulls),
@@ -8,12 +8,12 @@ In the examples below, substitute your Github username for `contributor` in URLs
88

99
## Fork the Project
1010

11-
Fork the [project on Github](https://github.com/CoCreate-app/CoCreateJS) and check out your copy.
11+
Fork the [project on Github](https://github.com/CoCreate-app/CoCreate-email) and check out your copy.
1212

1313
```
14-
git clone https://github.com/contributor/CoCreateJS.git
15-
cd CoCreateJS
16-
git remote add upstream https://github.com/CoCreate-app/CoCreateJS.git
14+
git clone https://github.com/contributor/CoCreate-email.git
15+
cd CoCreate-email
16+
git remote add upstream https://github.com/CoCreate-app/CoCreate-email.git
1717
```
1818

1919
## Create a Topic Branch
@@ -26,15 +26,6 @@ git pull upstream master
2626
git checkout -b my-feature-branch
2727
```
2828

29-
## Bundle Install and Test
30-
31-
Ensure that you can build the project and run tests.
32-
33-
```
34-
bundle install
35-
bundle exec rake
36-
```
37-
3829
## Write Tests
3930

4031
Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build.

README.md

Lines changed: 6 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# Realtime Admin CRM and CMS
2-
HTML Admin dashboard UI that can be used as a CRM and CMS. This html template is powered by [CoCreateJS](https://cocreate.app/documentation) to provide Realtime CRUD functionality and convert this admin template into a realtime web application. CoCreateJS is a makes use of data-attributes to Create, Read, Update and Delete in realtime. Can be used with any Html template to convert it in to a realtime website / web application.
1+
# CoCreate-email
2+
A simple HTML5 and pure javascript component. Easy configuration using data-attributes and highly styleable.
33

44
![CoCreate](https://cdn.cocreate.app/logo.png)
55

6-
[CoCreate Docs](https://cocreate.app/documentation)
6+
[CoCreate Docs](https://cocreate.app/documentation#CoCreate-email)
77

88
**This repository shows an example of CoCreteJS being used to power this crm, cms admin panel**
99

@@ -14,35 +14,16 @@ We appreciate your continued support, thank you!
1414
# Table of Contents
1515

1616
- [Table of Contents](#table-of-contents)
17-
- [Introduction - Please Read First](#introduction---please-read-first)
1817
- [Announcements](#announcements)
19-
- [Modules and Plugins](#announcements)
2018
- [Roadmap](#roadmap)
2119
- [How to Contribute](#how-to-contribute)
2220
- [About](#about)
2321
- [License](#license)
2422

25-
<a name="introduction"></a>
26-
# Introduction - Please Read First
27-
28-
This library is broken up into several packages as a monorepo so that you only need to install the packages necessary for your use case. This README contains information about all packages. For examples on how to get started quickly, head over to the READMEs of each package (linked and described below), which includes detailed examples.
29-
3023
<a name="announcements"></a>
3124
# Announcements
3225

33-
All updates to this library are documented in our [CHANGELOG](https://github.com/CoCreate-app/CoCreate-email/blob/master/CHANGELOG.md) and [releases](https://github.com/CoCreate-app/CoCreateJS/releases). You may also subscribe to email for releases and breaking changes.
34-
35-
<a name="modules"></a>
36-
# Modules and Plugins
37-
38-
* [Realtime Datatable](https://github.com/CoCreate-app/CoCreate-dataTable)
39-
* [Realtime Web Builder](https://github.com/CoCreate-app/CoCreate-builder)
40-
* [Conditional Logic](https://github.com/CoCreate-app/CoCreate-conditional-logic)
41-
* [Login and Register](https://github.com/CoCreate-app/CoCreate-users)
42-
* [Template Engine](https://github.com/CoCreate-app/CoCreate-templating)
43-
* [Cloning Elements](https://github.com/CoCreate-app//CoCreate-clone)
44-
* [Fullscreen Toggle](https://github.com/CoCreate-app/CoCreate-fullscreen)
45-
* [Movable Resizable Modals](https://github.com/CoCreate-app/CoCreate-modal)
26+
All updates to this library are documented in our [CHANGELOG](https://github.com/CoCreate-app/CoCreate-email/blob/master/CHANGELOG.md) and [releases](https://github.com/CoCreate-app/CoCreate-email/releases). You may also subscribe to email for releases and breaking changes.
4627

4728
<a name="roadmap"></a>
4829
# Roadmap
@@ -53,11 +34,11 @@ If you are interested in the future direction of this project, please take a loo
5334
<a name="about"></a>
5435
# About
5536

56-
CoCreateJS is guided and supported by the CoCreate Developer Experience Team.
37+
CoCreate-email is guided and supported by the CoCreate Developer Experience Team.
5738

5839
Please Email the Developer Experience Team [here](mailto:develop@cocreate.app) in case of any queries.
5940

60-
CoCreateJS is maintained and funded by CoCreate. The names and logos for CoCreate are trademarks of CoCreate, LLC.
41+
CoCreate-email is maintained and funded by CoCreate. The names and logos for CoCreate are trademarks of CoCreate, LLC.
6142

6243
<a name="contribute"></a>
6344
# How to Contribute

0 commit comments

Comments
 (0)