Skip to content

Commit a45cc2e

Browse files
Merge pull request #13 from memory-stack/fix/readme
Fix/readme
2 parents 66fa21f + bc2e59a commit a45cc2e

1 file changed

Lines changed: 21 additions & 44 deletions

File tree

README.md

Lines changed: 21 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,29 @@
11
# Memory Stack
22

3-
## _The Last Markdown Editor, Ever_
3+
![Build Status](https://shields.io/badge/build-passing-blueviolet?style=for-the-badge&logo=appveyor) ![NPM Version](https://shields.io/badge/npm-v1.0.0-yellow?style=for-the-badge&logo=appveyor) ![License](https://shields.io/badge/license-MIT-orange?style=for-the-badge&logo=appveyor)
44

5-
[![N|Solid](https://cldup.com/dTxpPi9lDf.thumb.png)](https://nodesource.com/products/nsolid)
65

7-
[![Build Status](https://travis-ci.org/joemccann/dillinger.svg?branch=master)](https://travis-ci.org/joemccann/dillinger)
6+
📜 Memory stack is a developer oriented, social journaling platform.
87

9-
Dillinger is a cloud-enabled, mobile-ready, offline-storage compatible,
10-
AngularJS-powered HTML5 Markdown editor.
11-
12-
- Type some Markdown on the left
13-
- See HTML in the right
8+
- Open your terminal
9+
- Log your thought
10+
- See your log being read by the world
1411
- ✨Magic ✨
1512

1613
## Features
1714

18-
Memory Stack is a day to day life event logging platform, which exploits the minimalist customs.
19-
2015
- Explore random events in the life of people across the globe.
21-
- Start the day by defining your mood.
22-
- Login, push your logs, monitor log histories, logout all of it from CLI!
23-
- Minimal user profiles structure.
24-
- Explore "a moment" in the life of other users or "delve" into their memory stack!
16+
- Minimal user interface.
17+
- Explore "a moment" in the life of other users or "delve" into their stack of memories!
2518
- mstak log "Emacs sucks!"...its that simple to make a small talk!
19+
- Login, push your logs, monitor log histories, logout all of it from CLI!
20+
2621

2722
## Installation
2823

29-
Memory Stack requires [Node.js](https://nodejs.org/) v10+ to run.
24+
Memory Stack requires [Node.js](https://nodejs.org/) to run.
3025

31-
Visit [Memory Stack signup page](https://memorystack.live/signup/) and create an account.
26+
Visit [Memory stack signup page](https://memorystack.live/signup/) and create an account.
3227

3328
Install the mstak NPM package globally.
3429

@@ -50,9 +45,8 @@ mstak log "this is my very first log"
5045

5146
## Commands
5247

53-
Dillinger is currently extended with the following plugins.
54-
Instructions on how to use them in your own application are linked below.
55-
Format : mstak <command> <input>
48+
Memory stack's CLI is used to log your thoughts on to the web.
49+
All the CLI commands are listed below.
5650

5751
| Command | Input | Details | Demo |
5852
| ------- | ------------------------- | -------------------------------------------- | --------------------------------------------------------------------------- |
@@ -62,32 +56,17 @@ Format : mstak <command> <input>
6256
| logs | none | Lists all the logs you've pushed today. | mstak logs |
6357
| setbio | Your desired bio | Changes your current bio to the desired bio. | mstak bio "A passionate developer from India, trying to make a difference!" |
6458

59+
Format : mstak <command> <input>
60+
6561
## Use Cases
6662

67-
Loren Ipsum need to insert something here
63+
This is how to use the web interface of Memory stack
6864

6965
| Endpoint | Details | Example |
7066
| ----------------------- | ----------------------------------------------- | ----------------------------------------------------------- |
7167
| /username | Displays the logged dates of the specified user | https://www.memorystack.live/void |
72-
| /username/datetime/logs | Displays the logs of a specified date and user | https://memorystack.tech/void/2021-11-18T07:44:39.970Z/logs |
73-
| /signup | Your log in double quotes | https://www.memorystack.live/signup |
74-
75-
Markdown is a lightweight markup language based on the formatting conventions
76-
that people naturally use in email.
77-
As [John Gruber] writes on the [Markdown site][df1]
78-
79-
> The overriding design goal for Markdown's
80-
> formatting syntax is to make it as readable
81-
> as possible. The idea is that a
82-
> Markdown-formatted document should be
83-
> publishable as-is, as plain text, without
84-
> looking like it's been marked up with tags
85-
> or formatting instructions.
86-
87-
This text you see here is \*actually- written in Markdown! To get a feel
88-
for Markdown's syntax, type some text into the left window and
89-
watch the results in the right.
90-
68+
| /username/date/logs | Displays the logs of a specified date and user | https://memorystack.tech/void/14-12-2021/logs |
69+
| /signup | Create an account | https://www.memorystack.live/signup |
9170

9271

9372
## Tech
@@ -100,16 +79,14 @@ Memory Stack uses a number of open source projects to work properly:
10079

10180
## Contributors
10281

103-
Want to contribute? Great!
82+
Memory stack is just an infant right now. We need you to make it something big.
10483

105-
<a href="https://github.com/memory-stack/frontend/graphs/contributors">
106-
<img src="https://contrib.rocks/image?repo=memory-stack/frontend" />
84+
<a href="https://github.com/memory-stack/memory-stack/graphs/contributors">
85+
<img src="https://contrib.rocks/image?repo=memory-stack/memory-stack" />
10786
</a>
10887

10988
Made with [contrib.rocks](https://contrib.rocks).
11089

111-
Dillinger uses Gulp + Webpack for fast developing.
112-
Make a change in your file and instantaneously see your updates!
11390

11491
## License
11592

0 commit comments

Comments
 (0)